Operating System fields
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. Serverless interfaces and procedures might differ from classic Elastic Stack deployments. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless
Generally available
Stack
Generally available
The OS fields contain information about the operating system.
| Field | Description | Level |
|---|---|---|
| os.family | OS family (such as redhat, debian, freebsd, windows). type: keyword example: debian |
extended |
| os.full | Operating system name, including the version or code name. type: keyword Multi-fields: * os.full.text (type: match_only_text) example: Mac OS Mojave  os.description |
extended |
| os.kernel | Operating system kernel version as a raw string. type: keyword example: 4.4.0-112-generic |
extended |
| os.name | Operating system name, without the version. type: keyword Multi-fields: * os.name.text (type: match_only_text) example: Mac OS X  os.name |
extended |
| os.platform | Operating system platform (such centos, ubuntu, windows). type: keyword example: darwin |
extended |
| os.type | Use the os.type field to categorize the operating system into one of the broad commercial families.If the OS you're dealing with is not listed as an expected value, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition. Expected values for this field: * linux* macos* unix* windows* ios* androidtype: keyword example: macos  os.typeNote: The expected values in ECS for os.type do not correspond with the values defined in semantic conventions! |
extended |
| os.version | Operating system version as a raw string. type: keyword example: 10.14.1 os.version |
extended |
The os fields are expected to be nested at:
host.osobserver.osuser_agent.os
Note also that the os fields are not expected to be used directly at the root of the events.