Skip to content

Commit 8ec6180

Browse files
carsonipcarsonip
authored
[exporter/elasticsearch] Translate k8s.*.name resource attributes in ECS mode (#36233)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description In ECS mode: Translate `k8s.job.name`, `k8s.cronjob.name`, `k8s.statefulset.name`, `k8s.replicaset.name`, `k8s.daemonset.name`, `k8s.container.name` to `kubernetes.*.name`. Translate `k8s.cluster.name` to `orchestrator.cluster.name`. <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> #### Link to tracking issue <!--Describe what testing was performed and which tests were added.--> #### Testing <!--Describe the documentation added.--> #### Documentation <!--Please delete paragraphs that you did not use before submitting.-->
1 parent 65cd1f9 commit 8ec6180

File tree

4 files changed

+81
-26
lines changed

4 files changed

+81
-26
lines changed

‎.chloggen/elasticsearchexporter_ecs-translate-k8s-names.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: elasticsearchexporter
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Translate `k8s.*.name` resource attributes in ECS mode
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [36233]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext: Translate `k8s.job.name`, `k8s.cronjob.name`, `k8s.statefulset.name`, `k8s.replicaset.name`, `k8s.daemonset.name`, `k8s.container.name` to `kubernetes.*.name`. Translate `k8s.cluster.name` to `orchestrator.cluster.name`.
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: [user]

‎exporter/elasticsearchexporter/README.md

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -268,31 +268,38 @@ If the target ECS field name is specified as an empty string (""), the converter
268268

269269
When "Preserved" is true, the attribute will be preserved in the payload and duplicated as mapped to its ECS equivalent.
270270

271-
| Semantic Convention Name | ECS Name | Preserve |
272-
|--------------------------|----------|----------|
273-
| cloud.platform | cloud.service.name | false |
274-
| container.image.tags | container.image.tag | false |
275-
| deployment.environment | service.environment | false |
276-
| host.arch | host.architecture | false |
277-
| host.name | host.hostname | true |
278-
| k8s.deployment.name | kubernetes.deployment.name | false |
279-
| k8s.namespace.name | kubernetes.namespace | false |
280-
| k8s.node.name | kubernetes.node.name | false |
281-
| k8s.pod.name | kubernetes.pod.name | false |
282-
| k8s.pod.uid | kubernetes.pod.uid | false |
283-
| os.description | host.os.full | false |
284-
| os.name | host.os.name | false |
285-
| os.type | host.os.platform | false |
286-
| os.version | host.os.version | false |
287-
| process.executable.path | process.executable | false |
288-
| process.runtime.name | service.runtime.name | false |
289-
| process.runtime.version | service.runtime.version | false |
290-
| service.instance.id | service.node.name | false |
291-
| telemetry.distro.name | "" | false |
292-
| telemetry.distro.version | "" | false |
293-
| telemetry.sdk.language | "" | false |
294-
| telemetry.sdk.name | "" | false |
295-
| telemetry.sdk.version | "" | false |
271+
| Semantic Convention Name | ECS Name | Preserve |
272+
|--------------------------|-----------------------------|----------|
273+
| cloud.platform | cloud.service.name | false |
274+
| container.image.tags | container.image.tag | false |
275+
| deployment.environment | service.environment | false |
276+
| host.arch | host.architecture | false |
277+
| host.name | host.hostname | true |
278+
| k8s.cluster.name | orchestrator.cluster.name | false |
279+
| k8s.container.name | kubernetes.container.name | false |
280+
| k8s.cronjob.name | kubernetes.cronjob.name | false |
281+
| k8s.daemonset.name | kubernetes.daemonset.name | false |
282+
| k8s.deployment.name | kubernetes.deployment.name | false |
283+
| k8s.job.name | kubernetes.job.name | false |
284+
| k8s.namespace.name | kubernetes.namespace | false |
285+
| k8s.node.name | kubernetes.node.name | false |
286+
| k8s.pod.name | kubernetes.pod.name | false |
287+
| k8s.pod.uid | kubernetes.pod.uid | false |
288+
| k8s.replicaset.name | kubernetes.replicaset.name | false |
289+
| k8s.statefulset.name | kubernetes.statefulset.name | false |
290+
| os.description | host.os.full | false |
291+
| os.name | host.os.name | false |
292+
| os.type | host.os.platform | false |
293+
| os.version | host.os.version | false |
294+
| process.executable.path | process.executable | false |
295+
| process.runtime.name | service.runtime.name | false |
296+
| process.runtime.version | service.runtime.version | false |
297+
| service.instance.id | service.node.name | false |
298+
| telemetry.distro.name | "" | false |
299+
| telemetry.distro.version | "" | false |
300+
| telemetry.sdk.language | "" | false |
301+
| telemetry.sdk.name | "" | false |
302+
| telemetry.sdk.version | "" | false |
296303

297304
### Compound Mapping
298305

‎exporter/elasticsearchexporter/model.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,13 @@ var resourceAttrsConversionMap = map[string]string{
5757
semconv.AttributeK8SNodeName: "kubernetes.node.name",
5858
semconv.AttributeK8SPodName: "kubernetes.pod.name",
5959
semconv.AttributeK8SPodUID: "kubernetes.pod.uid",
60+
semconv.AttributeK8SJobName: "kubernetes.job.name",
61+
semconv.AttributeK8SCronJobName: "kubernetes.cronjob.name",
62+
semconv.AttributeK8SStatefulSetName: "kubernetes.statefulset.name",
63+
semconv.AttributeK8SReplicaSetName: "kubernetes.replicaset.name",
64+
semconv.AttributeK8SDaemonSetName: "kubernetes.daemonset.name",
65+
semconv.AttributeK8SContainerName: "kubernetes.container.name",
66+
semconv.AttributeK8SClusterName: "orchestrator.cluster.name",
6067
}
6168

6269
// resourceAttrsToPreserve contains conventions that should be preserved in ECS mode.

‎exporter/elasticsearchexporter/model_test.go

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,13 @@ func TestEncodeLogECSMode(t *testing.T) {
381381
"k8s.pod.name": "opentelemetry-pod-autoconf",
382382
"k8s.pod.uid": "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff",
383383
"k8s.deployment.name": "coredns",
384+
semconv.AttributeK8SJobName: "job.name",
385+
semconv.AttributeK8SCronJobName: "cronjob.name",
386+
semconv.AttributeK8SStatefulSetName: "statefulset.name",
387+
semconv.AttributeK8SReplicaSetName: "replicaset.name",
388+
semconv.AttributeK8SDaemonSetName: "daemonset.name",
389+
semconv.AttributeK8SContainerName: "container.name",
390+
semconv.AttributeK8SClusterName: "cluster.name",
384391
})
385392
require.NoError(t, err)
386393

@@ -444,7 +451,14 @@ func TestEncodeLogECSMode(t *testing.T) {
444451
"kubernetes.node.name": "node-1",
445452
"kubernetes.pod.name": "opentelemetry-pod-autoconf",
446453
"kubernetes.pod.uid": "275ecb36-5aa8-4c2a-9c47-d8bb681b9aff",
447-
"kubernetes.deployment.name": "coredns"
454+
"kubernetes.deployment.name": "coredns",
455+
"kubernetes.job.name": "job.name",
456+
"kubernetes.cronjob.name": "cronjob.name",
457+
"kubernetes.statefulset.name": "statefulset.name",
458+
"kubernetes.replicaset.name": "replicaset.name",
459+
"kubernetes.daemonset.name": "daemonset.name",
460+
"kubernetes.container.name": "container.name",
461+
"orchestrator.cluster.name": "cluster.name"
448462
}`, buf.String())
449463
}
450464

0 commit comments

Comments
 (0)