Skip to content

Commit 7f5e2b1

Browse files
Consolidate Observability field reference pages (#1067)
With the removal of the Logs App, the Infrastructure App was the only fields guide left. There was also a serverless and stateful page that contained the same information, but formatted differently, so I consolidated that as well. --------- Co-authored-by: Colleen McGinnis <[email protected]>
1 parent f938254 commit 7f5e2b1

File tree

8 files changed

+356
-519
lines changed

8 files changed

+356
-519
lines changed

redirects.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ redirects:
55
'deploy-manage/security/ece-traffic-filtering-through-the-api.md': 'deploy-manage/security/ec-traffic-filtering-through-the-api.md'
66
'deploy-manage/security/install-stack-demo-secure.md': '!deploy-manage/security/self-setup.md'
77
'reference/observability/fields-and-object-schemas/logs-app-fields.md': '!reference/observability/fields-and-object-schemas.md'
8+
'reference/observability/fields-and-object-schemas/metrics-app-fields.md': '!reference/observability/fields-and-object-schemas.md'
89
# Related to https://github.com/elastic/docs-content/pull/1069
910
'solutions/observability/apps/llm-observability.md': 'solutions/observability/applications/llm-observability.md'
1011
'solutions/observability/apps.md': 'solutions/observability/applications/index.md'
@@ -183,4 +184,4 @@ redirects:
183184
'solutions/observability/apps/analyze-monitors.md': 'solutions/observability/uptime/analyze-monitors.md'
184185
'solutions/observability/apps/inspect-uptime-duration-anomalies.md': 'solutions/observability/uptime/inspect-duration-anomalies.md'
185186
'solutions/observability/apps/configure-settings.md': 'solutions/observability/uptime/configure-settings.md'
186-
'solutions/observability/apps/tutorial-monitor-java-application.md': 'solutions/observability/applications/tutorial-monitor-java-application.md'
187+
'solutions/observability/apps/tutorial-monitor-java-application.md': 'solutions/observability/applications/tutorial-monitor-java-application.md'

reference/data-analysis/observability/observability-aws-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ To analyze RDS database metrics, you can select view filters based on the follow
6464
| **Active Transactions** | Average of `aws.rds.transactions.active`. |
6565
| **Latency** | Average of `aws.rds.latency.dml`. |
6666

67-
For information about the fields used by the Infrastructure UI to display AWS services metrics, see the [Infrastructure app fields](/reference/observability/serverless/infrastructure-app-fields.md).
67+
For information about the fields used by the Infrastructure UI to display AWS services metrics, see the [Infrastructure app fields](/reference/observability/fields-and-object-schemas.md).

reference/data-analysis/observability/observability-kubernetes-pod-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ To analyze Kubernetes pod metrics, you can select view filters based on the foll
1515
| **Inbound Traffic** | Derivative of the maximum of `kubernetes.pod.network.rx.bytes` scaled to a 1 second rate. |
1616
| **Outbound Traffic** | Derivative of the maximum of `kubernetes.pod.network.tx.bytes` scaled to a 1 second rate. |
1717

18-
For information about the fields used by the Infrastructure UI to display Kubernetes pod metrics, see the [Infrastructure app fields](/reference/observability/serverless/infrastructure-app-fields.md).
18+
For information about the fields used by the Infrastructure UI to display Kubernetes pod metrics, see the [Infrastructure app fields](/reference/observability/fields-and-object-schemas.md).

reference/observability/fields-and-object-schemas.md

Lines changed: 351 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
2+
applies_to:
3+
stack: all
4+
serverless: all
25
mapped_pages:
36
- https://www.elastic.co/guide/en/observability/current/fields-reference.html
7+
- https://www.elastic.co/guide/en/observability/current/metrics-app-fields.html
8+
- https://www.elastic.co/guide/en/serverless/current/observability-infrastructure-monitoring-required-fields.html
49
---
510

611
# Fields and object schemas [fields-reference]
@@ -11,7 +16,352 @@ ECS is an open source specification that defines a standard set of fields to use
1116

1217
Beat modules (for example, [{{filebeat}} modules](beats://reference/filebeat/filebeat-modules.md)) are ECS-compliant, so manual field mapping is not required, and all data is populated automatically in the Infrastructure app. If you cannot use {{beats}}, map your data to [ECS fields](ecs://reference/ecs-converting.md)). You can also try using the experimental [ECS Mapper](https://github.com/elastic/ecs-mapper) tool.
1318

14-
This reference covers [{{infrastructure-app}} fields](/reference/observability/fields-and-object-schemas/metrics-app-fields.md).
19+
This reference covers {{infrastructure-app}} fields.
1520

21+
## Infrastructure app fields [metrics-app-fields]
1622

23+
This section lists the required fields the {{infrastructure-app}} uses to display data. Please note that some of the fields listed are not [ECS fields](ecs://reference/index.md#_what_is_ecs).
1724

25+
### Additional field details [_additional_field_details]
26+
27+
The `event.dataset` field is required to display data properly in some views. This field is a combination of `metricset.module`, which is the {{metricbeat}} module name, and `metricset.name`, which is the metricset name.
28+
29+
To determine each metric’s optimal time interval, all charts use `metricset.period`. If `metricset.period` is not available, then it falls back to 1 minute intervals.
30+
31+
### Base fields [base-fields]
32+
33+
The `base` field set contains all fields which are on the top level. These fields are common across all types of events.
34+
35+
`@timestamp`
36+
: Date/time when the event originated.
37+
38+
This is the date/time extracted from the event, typically representing when the source generated the event. If the event source has no original timestamp, this value is typically populated by the first time the pipeline received the event. Required field for all events.
39+
40+
type: date
41+
42+
required: True
43+
44+
ECS field: True
45+
46+
example: `May 27, 2020 @ 15:22:27.982`
47+
48+
`message`
49+
: For log events the message field contains the log message, optimized for viewing in a log viewer.
50+
51+
For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event.
52+
53+
If multiple messages exist, they can be combined into one message.
54+
55+
type: text
56+
57+
required: True
58+
59+
ECS field: True
60+
61+
example: `Hello World`
62+
63+
### Hosts fields [host-fields]
64+
65+
These fields must be mapped to display host data in the {{infrastructure-app}}.
66+
67+
`host.name`
68+
: Name of the host.
69+
70+
It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.
71+
72+
type: keyword
73+
74+
required: True
75+
76+
ECS field: True
77+
78+
example: `MacBook-Elastic.local`
79+
80+
`host.ip`
81+
: IP of the host that records the event.
82+
83+
type: `ip`
84+
85+
required: True
86+
87+
ECS field: True
88+
89+
### Docker container fields [docker-fields]
90+
91+
These fields must be mapped to display Docker container data in the {{infrastructure-app}}.
92+
93+
`container.id`
94+
: Unique container id.
95+
96+
type: keyword
97+
98+
required: True
99+
100+
ECS field: True
101+
102+
example: `data`
103+
104+
`container.name`
105+
: Container name.
106+
107+
type: keyword
108+
109+
required: True
110+
111+
ECS field: True
112+
113+
`container.ip_address`
114+
: IP of the container.
115+
116+
type: `ip`
117+
118+
required: True
119+
120+
ECS field: False
121+
122+
### Kubernetes pod fields [kubernetes-fields]
123+
124+
These fields must be mapped to display Kubernetes pod data in the {{infrastructure-app}}.
125+
126+
`kubernetes.pod.uid`
127+
: Kubernetes Pod UID.
128+
129+
type: keyword
130+
131+
required: True
132+
133+
ECS field: False
134+
135+
example: `8454328b-673d-11ea-7d80-21010a840123`
136+
137+
`kubernetes.pod.name`
138+
: Kubernetes pod name.
139+
140+
type: keyword
141+
142+
required: True
143+
144+
ECS field: False
145+
146+
example: `nginx-demo`
147+
148+
`kubernetes.pod.ip`
149+
: IP of the Kubernetes pod.
150+
151+
type: keyword
152+
153+
required: True
154+
155+
ECS field: False
156+
157+
### AWS EC2 instance fields [aws-ec2-fields]
158+
159+
These fields must be mapped to display EC2 instance data in the {{infrastructure-app}}.
160+
161+
`cloud.instance.id`
162+
: Instance ID of the host machine.
163+
164+
type: keyword
165+
166+
required: True
167+
168+
ECS field: True
169+
170+
example: `i-1234567890abcdef0`
171+
172+
`cloud.instance.name`
173+
: Instance name of the host machine.
174+
175+
type: keyword
176+
177+
required: True
178+
179+
ECS field: True
180+
181+
`aws.ec2.instance.public.ip`
182+
: Instance public IP of the host machine.
183+
184+
type: keyword
185+
186+
required: True
187+
188+
ECS field: False
189+
190+
### AWS S3 bucket fields [aws-s3-fields]
191+
192+
These fields must be mapped to display S3 bucket data in the {{infrastructure-app}}.
193+
194+
`aws.s3.bucket.name`
195+
: The name or ID of the AWS S3 bucket.
196+
197+
type: keyword
198+
199+
required: True
200+
201+
ECS field: False
202+
203+
### AWS SQS queue fields [aws-sqs-fields]
204+
205+
These fields must be mapped to display SQS queue data in the {{infrastructure-app}}.
206+
207+
`aws.sqs.queue.name`
208+
: The name or ID of the AWS SQS queue.
209+
210+
type: keyword
211+
212+
required: True
213+
214+
ECS field: False
215+
216+
### AWS RDS database fields [aws-rds-fields]
217+
218+
These fields must be mapped to display RDS database data in the {{infrastructure-app}}.
219+
220+
`aws.rds.db_instance.arn`
221+
: Amazon Resource Name (ARN) for each RDS.
222+
223+
type: keyword
224+
225+
required: True
226+
227+
ECS field: False
228+
229+
`aws.rds.db_instance.identifier`
230+
: Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
231+
232+
type: keyword
233+
234+
required: True
235+
236+
ECS field: False
237+
238+
### Additional grouping fields [group-inventory-fields]
239+
240+
Depending on which entity you select in the **Infrastructure inventory** view, these additional fields can be mapped to group entities by.
241+
242+
`cloud.availability_zone`
243+
: Availability zone in which this host is running.
244+
245+
type: keyword
246+
247+
required: True
248+
249+
ECS field: True
250+
251+
example: `us-east-1c`
252+
253+
`cloud.machine.type`
254+
: Machine type of the host machine.
255+
256+
type: keyword
257+
258+
required: True
259+
260+
ECS field: True
261+
262+
example: `t2.medium`
263+
264+
`cloud.region`
265+
: Region in which this host is running.
266+
267+
type: keyword
268+
269+
required: True
270+
271+
ECS field: True
272+
273+
example: `us-east-1`
274+
275+
`cloud.instance.id`
276+
: Instance ID of the host machine.
277+
278+
type: keyword
279+
280+
required: True
281+
282+
ECS field: True
283+
284+
example: `i-1234567890abcdef0`
285+
286+
`cloud.provider`
287+
: Name of the cloud provider. Example values are `aws`, `azure`, `gcp`, or `digitalocean`.
288+
289+
type: keyword
290+
291+
required: True
292+
293+
ECS field: True
294+
295+
example: `aws`
296+
297+
`cloud.instance.name`
298+
: Instance name of the host machine.
299+
300+
type: keyword
301+
302+
required: True
303+
304+
ECS field: True
305+
306+
`cloud.project.id`
307+
: Name of the project in Google Cloud.
308+
309+
type: keyword
310+
311+
required: True
312+
313+
ECS field: False
314+
315+
`service.type`
316+
: The type of the service data is collected from.
317+
318+
The type can be used to group and correlate logs and metrics from one service type.
319+
320+
Example: If metrics are collected from {{es}}, service.type would be `elasticsearch`.
321+
322+
type: keyword
323+
324+
required: True
325+
326+
ECS field: False
327+
328+
example: `elasticsearch`
329+
330+
`host.hostname`
331+
: Name of the host.
332+
333+
It normally contains what the `hostname` command returns on the host machine.
334+
335+
type: keyword
336+
337+
required: True, if you want to use the {{ml-features}}.
338+
339+
ECS field: True
340+
341+
example: `Elastic.local`
342+
343+
`host.os.name`
344+
: Operating system name, without the version.
345+
346+
Multi-fields:
347+
348+
* os.name.text (type: text)
349+
350+
type: keyword
351+
352+
required: True
353+
354+
ECS field: True
355+
356+
example: `Mac OS X`
357+
358+
`host.os.kernel`
359+
: Operating system kernel version as a raw string.
360+
361+
type: keyword
362+
363+
required: True
364+
365+
ECS field: True
366+
367+
example: `4.4.0-112-generic`

0 commit comments

Comments
 (0)