Add service environment configuration to elastic exporter

[vinsce]

Based on the Kibana documentation, the special field service.environment is used to identify the environment of the service. If the variable is not specified, the environment associated with the service is Not defined.

However the service.environment variable is not recognized by the elastic exporter, and it is considered a generic label and converted to labels.service_environment:

This is the collector configuration I'm using:

receivers:
  otlp:
    endpoint: "localhost:55680"

processors:
    resource/service:
        labels: {
          "service.environment": "test",
          "service.name": "application name"
        }
    batch:
        timeout: 1s
        send_batch_size: 1024

exporters:
    elastic:
        apm_server_url: "http://localhost:8200"

service:
    pipelines:
        traces:
            receivers: [otlp]
            processors: [batch, resource/service]
            exporters: [elastic]

The service.name is correctly propagated to elastic as it is but the service.environment is not.

[jrcamp]

@axw looks like you added the initial elastic implementation, can you take a look at this?

[axw]

Thanks for the ping @jrcamp, will do.

[axw]

We can certainly look for service.environment as requested, but I wonder if we should be using service.namespace instead. That would be nice in that it's a defined attribute, and an environment is a kind of namespace; but not all namespaces may be considered "environments".

@cyrille-leclerc thoughts?

[cyrille-leclerc]

FYI, after discussing with @axw , we have created open-telemetry/opentelemetry-specification#752

[axw]

open-telemetry/opentelemetry-specification#606 was recently merged, adding the deployment.environment attribute. We should translate from that to service.environment ECS/Elastic APM field, which has the same semantics.

[axw]

Quick update: there's ongoing discussion about the new convention at open-telemetry/opentelemetry-specification#851. Once that is resolved, I'll update the Elastic exporter.

[cyrille-leclerc]

@vinsce here is a sample to define the deployment.environment on your OpenTelemetry instrumentation and get it mapped to the service.environment in Elastic APM. It requires to use the version 0.11+ of the OpenTelemetry Collector:

export OTEL_RESOURCE_ATTRIBUTES=service.name=monitor,service.namespace=com-shoppingcart,service.version=1.0-SNAPSHOT,deployment.environment=staging

java -javaagent:$OPEN_TELEMETRY_AGENT_JAR \
     -Dotel.otlp.endpoint=localhost:55680 \
     -classpath target/classes/ FrontendMonitor

[vinsce]

Tested with the OpenTelemetry Collector 0.11. Thank you