Service Fields
editService Fields
editThe service fields describe the service for or from which the data was collected.
These fields help you find and correlate logs for a specific service and version.
Service Field Details
editField | Description | Level |
---|---|---|
Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). type: keyword example: |
extended |
|
[beta] This field is beta and subject to change. Identifies the environment where the service is running. If the same service runs in different environments (production, staging, QA, development, etc.), the environment can identify other instances of the same service. Can also group services and applications from the same environment. type: keyword example: |
extended |
|
Ephemeral identifier of this service (if one exists). This id normally changes across restarts, but type: keyword example: |
extended |
|
Unique identifier of the running service. If the service is comprised of many nodes, the This id should uniquely identify the service. This makes it possible to correlate logs and metrics for one specific service, no matter which particular node emitted the event. Note that if you need to see the events from one specific host of the service, you should filter on that type: keyword example: |
core |
|
Name of the service data is collected from. The name of the service is normally user given. This allows for distributed services that run on multiple hosts to correlate the related instances based on the name. In the case of Elasticsearch the type: keyword example: |
core |
|
Name of a service node. This allows for two nodes of the same service running on the same host to be differentiated. Therefore, In the case of Elasticsearch, the type: keyword example: |
extended |
|
Deprecated for removal in next major version release. This field will be superseded by Role of a service node. This allows for distinction between different running roles of the same service. In the case of Kibana, the In the case of Elasticsearch, the Other services could use this to distinguish between a type: keyword example: |
extended |
|
Roles of a service node. This allows for distinction between different running roles of the same service. In the case of Kibana, the In the case of Elasticsearch, the Other services could use this to distinguish between a type: keyword Note: this field should contain an array of values. example: |
extended |
|
Current state of the service. type: keyword |
core |
|
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, type: keyword example: |
core |
|
Version of the service the data was collected from. This allows to look at a data set only for a specific version of a service. type: keyword example: |
core |
Field Reuse
editThe service
fields are expected to be nested at:
-
service.origin
-
service.target
Note also that the service
fields may be used directly at the root of the events.
Field sets that can be nested under Service
editLocation | Field Set | Description |
---|---|---|
|
[beta]
Reusing the Describes the origin service in case of an incoming request or event. |
|
|
[beta]
Reusing the Describes the target service in case of an outgoing request or event. |
Service Field Usage
editFor usage and examples of the service fields, please see the Service Fields Usage and Examples section.