diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 9b4d3f048ce..9e70637d174 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -305,6 +305,7 @@ /packages/jamf_compliance_reporter @elastic/security-service-integrations /packages/jamf_pro @elastic/security-service-integrations /packages/jamf_protect @elastic/security-service-integrations +/packages/jaeger_input_otel @elastic/ecosystem /packages/jolokia_input @elastic/obs-infraobs-integrations /packages/journald @elastic/elastic-agent-data-plane /packages/jumpcloud @elastic/security-service-integrations diff --git a/.github/ISSUE_TEMPLATE/integration_bug.yml b/.github/ISSUE_TEMPLATE/integration_bug.yml index 39d41a7066d..648e05a38d7 100644 --- a/.github/ISSUE_TEMPLATE/integration_bug.yml +++ b/.github/ISSUE_TEMPLATE/integration_bug.yml @@ -214,6 +214,7 @@ body: - IIS OpenTelemetry assets [iis_otel] - IIS OpenTelemetry Input Package [iis_input_otel] - IIS [iis] + - Jaeger OpenTelemetry Input Package [jaeger_input_otel] - Imperva Cloud WAF [imperva_cloud_waf] - Imperva [imperva] - InfluxDb [influxdb] diff --git a/.github/ISSUE_TEMPLATE/integration_feature_request.yml b/.github/ISSUE_TEMPLATE/integration_feature_request.yml index 85ba55ab1f1..6216edb6ef0 100644 --- a/.github/ISSUE_TEMPLATE/integration_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/integration_feature_request.yml @@ -214,6 +214,7 @@ body: - IIS OpenTelemetry assets [iis_otel] - IIS OpenTelemetry Input Package [iis_input_otel] - IIS [iis] + - Jaeger OpenTelemetry Input Package [jaeger_input_otel] - Imperva Cloud WAF [imperva_cloud_waf] - Imperva [imperva] - InfluxDb [influxdb] diff --git a/packages/jaeger_input_otel/LICENSE.txt b/packages/jaeger_input_otel/LICENSE.txt new file mode 100644 index 00000000000..4fe45f1e890 --- /dev/null +++ b/packages/jaeger_input_otel/LICENSE.txt @@ -0,0 +1,93 @@ +Elastic License 2.0 + +URL: https://www.elastic.co/licensing/elastic-license + +## Acceptance + +By using the software, you agree to all of the terms and conditions below. + +## Copyright License + +The licensor grants you a non-exclusive, royalty-free, worldwide, +non-sublicensable, non-transferable license to use, copy, distribute, make +available, and prepare derivative works of the software, in each case subject to +the limitations and conditions below. + +## Limitations + +You may not provide the software to third parties as a hosted or managed +service, where the service provides users with access to any substantial set of +the features or functionality of the software. + +You may not move, change, disable, or circumvent the license key functionality +in the software, and you may not remove or obscure any functionality in the +software that is protected by the license key. + +You may not alter, remove, or obscure any licensing, copyright, or other notices +of the licensor in the software. Any use of the licensor's trademarks is subject +to applicable law. + +## Patents + +The licensor grants you a license, under any patent claims the licensor can +license, or becomes able to license, to make, have made, use, sell, offer for +sale, import and have imported the software, in each case subject to the +limitations and conditions in this license. This license does not cover any +patent claims that you cause to be infringed by modifications or additions to +the software. If you or your company make any written claim that the software +infringes or contributes to infringement of any patent, your patent license for +the software granted under these terms ends immediately. If your company makes +such a claim, your patent license ends immediately for work on behalf of your +company. + +## Notices + +You must ensure that anyone who gets a copy of any part of the software from you +also gets a copy of these terms. + +If you modify the software, you must include in any modified copies of the +software prominent notices stating that you have modified the software. + +## No Other Rights + +These terms do not imply any licenses other than those expressly granted in +these terms. + +## Termination + +If you use the software in violation of these terms, such use is not licensed, +and your licenses will automatically terminate. If the licensor provides you +with a notice of your violation, and you cease all violation of this license no +later than 30 days after you receive that notice, your licenses will be +reinstated retroactively. However, if you violate these terms after such +reinstatement, any additional violation will cause your licenses to terminate +automatically and permanently. + +## No Liability + +*As far as the law allows, the software comes as is, without any warranty or +condition, and the licensor will not be liable to you for any damages arising +out of these terms or the use or nature of the software, under any kind of +legal claim.* + +## Definitions + +The **licensor** is the entity offering these terms, and the **software** is the +software the licensor makes available under these terms, including any portion +of it. + +**you** refers to the individual or entity agreeing to these terms. + +**your company** is any legal entity, sole proprietorship, or other kind of +organization that you work for, plus all organizations that have control over, +are under the control of, or are under common control with that +organization. **control** means ownership of substantially all the assets of an +entity, or the power to direct its management and policies by vote, contract, or +otherwise. Control can be direct or indirect. + +**your licenses** are all the licenses granted to you for the software under +these terms. + +**use** means anything you do with the software requiring one of your licenses. + +**trademark** means trademarks, service marks, and similar rights. diff --git a/packages/jaeger_input_otel/_dev/build/docs/README.md b/packages/jaeger_input_otel/_dev/build/docs/README.md new file mode 100644 index 00000000000..f26babba052 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/build/docs/README.md @@ -0,0 +1,25 @@ +# Jaeger OpenTelemetry Input Package + +## Overview +The Jaeger OpenTelemetry Input Package for Elastic enables collection of trace data in [Jaeger](https://www.jaegertracing.io/) format over **gRPC** using the [jaegerreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jaegerreceiver). + +**Jaeger and OpenTelemetry:** This input receives traces in **Jaeger format** (legacy Protobuf gRPC, Thrift HTTP), not OTLP. Jaeger and OpenTelemetry serve different roles—Jaeger is a tracing backend while OpenTelemetry provides SDKs for instrumentation; both support compatible trace models. For details on protocols, compatibility, and migration, see the [Jaeger documentation](https://www.jaegertracing.io/docs/2.15/) and the [jaegerreceiver README](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/jaegerreceiver/README.md). + +**Requirements:** Kibana 9.4.0 or later (traces support), Elastic Agent with Elastic Distribution of OpenTelemetry (EDOT). + +### How it works +This package receives trace data from Jaeger clients and agents by configuring the Jaeger gRPC receiver in the Input Package, which then gets applied to the jaegerreceiver present in the Elastic Distribution of OpenTelemetry (EDOT) collector, which then forwards the data to Elastic Agent. The Elastic Agent processes and enriches the data before sending it to Elasticsearch for indexing and analysis. + +### Protocols +Traces are received over gRPC (required) and optionally Thrift HTTP. + +| Setting | Default | Description | +|---------------|------------------|--------------------------------| +| **gRPC endpoint** | localhost:14250 | Listen address for Jaeger gRPC | +| **Thrift HTTP endpoint** | — | Optional. When set, enables Thrift HTTP (e.g. localhost:14268) for Jaeger agent compatibility | +| **Enable TLS** | false | Use TLS for secure gRPC connections | +| **TLS Certificate File** | — | Path to server certificate | +| **TLS Key File** | — | Path to server private key | +| **TLS Client CA File** | — | Path to CA for client verification (mTLS) | + +For protocol options, TLS/mTLS advanced configuration, and UDP protocols (thrift), refer to the [Jaeger Receiver README](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/jaegerreceiver/README.md) in the upstream OpenTelemetry Collector Contrib repository. diff --git a/packages/jaeger_input_otel/_dev/deploy/docker/Dockerfile b/packages/jaeger_input_otel/_dev/deploy/docker/Dockerfile new file mode 100644 index 00000000000..3d943e2aee4 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/deploy/docker/Dockerfile @@ -0,0 +1,11 @@ +FROM python:3.11-slim + +WORKDIR /app + +COPY requirements.txt . +RUN pip install --no-cache-dir -r requirements.txt + +COPY scripts/ ./scripts/ + +WORKDIR /app/scripts +CMD ["python", "send_jaeger_traces.py"] diff --git a/packages/jaeger_input_otel/_dev/deploy/docker/docker-compose.yml b/packages/jaeger_input_otel/_dev/deploy/docker/docker-compose.yml new file mode 100644 index 00000000000..3de0e4ae9f6 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/deploy/docker/docker-compose.yml @@ -0,0 +1,7 @@ +services: + jaeger_trace_sender: + build: . + environment: + OTEL_EXPORTER_JAEGER_ENDPOINT: http://elastic-agent:14268/api/traces + OTEL_SERVICE_NAME: test-service + command: ["python", "send_jaeger_traces.py"] diff --git a/packages/jaeger_input_otel/_dev/deploy/docker/requirements.txt b/packages/jaeger_input_otel/_dev/deploy/docker/requirements.txt new file mode 100644 index 00000000000..059018de45e --- /dev/null +++ b/packages/jaeger_input_otel/_dev/deploy/docker/requirements.txt @@ -0,0 +1,5 @@ +opentelemetry-api>=1.3.0 +opentelemetry-sdk>=1.11.0 +opentelemetry-exporter-jaeger-thrift>=1.11.0 +deprecated>=1.2.0 +thrift>=0.10.0 diff --git a/packages/jaeger_input_otel/_dev/deploy/docker/scripts/send_jaeger_traces.py b/packages/jaeger_input_otel/_dev/deploy/docker/scripts/send_jaeger_traces.py new file mode 100644 index 00000000000..84e744533fe --- /dev/null +++ b/packages/jaeger_input_otel/_dev/deploy/docker/scripts/send_jaeger_traces.py @@ -0,0 +1,71 @@ +#!/usr/bin/env python3 +""" +Generate and send traces in Jaeger Thrift HTTP format to the collector. +Used for system testing the jaeger_input_otel package. +Waits for SIGHUP from elastic-package (sent when agent is ready) before sending. +""" +import os +import signal +import time + +from opentelemetry import trace +from opentelemetry.exporter.jaeger.thrift import JaegerExporter +from opentelemetry.sdk.resources import SERVICE_NAME, Resource +from opentelemetry.sdk.trace import TracerProvider +from opentelemetry.sdk.trace.export import BatchSpanProcessor + +# Default endpoint for elastic-package system tests (elastic-agent is the Agent hostname) +DEFAULT_ENDPOINT = "http://elastic-agent:14268/api/traces" +ENDPOINT = os.environ.get("OTEL_EXPORTER_JAEGER_ENDPOINT", DEFAULT_ENDPOINT) + +# Ensure format parameter is set for Jaeger Thrift +if "?" not in ENDPOINT: + ENDPOINT = f"{ENDPOINT}?format=jaeger.thrift" + +SERVICE_NAME_VALUE = os.environ.get("OTEL_SERVICE_NAME", "test-service") + +agent_ready = False + + +def sighup_handler(signum, frame): + global agent_ready + agent_ready = True + + +def main(): + signal.signal(signal.SIGHUP, sighup_handler) + print("Waiting for SIGHUP (agent ready signal)...") + while not agent_ready: + time.sleep(0.1) + print("Agent ready, sending traces...") + + resource = Resource.create({SERVICE_NAME: SERVICE_NAME_VALUE}) + trace.set_tracer_provider(TracerProvider(resource=resource)) + + jaeger_exporter = JaegerExporter( + collector_endpoint=ENDPOINT, + ) + span_processor = BatchSpanProcessor(jaeger_exporter) + trace.get_tracer_provider().add_span_processor(span_processor) + + tracer = trace.get_tracer("jaeger-trace-sender", "1.0.0") + + print(f"Sending traces to {ENDPOINT}...") + + # Generate multiple traces with spans for reliable test data + for i in range(5): + with tracer.start_as_current_span(f"operation-{i}") as span: + span.set_attribute("test.iteration", i) + span.set_attribute("test.service", SERVICE_NAME_VALUE) + with tracer.start_as_current_span("child-span"): + time.sleep(0.1) + + # Force flush to ensure all spans are exported + trace.get_tracer_provider().force_flush() + trace.get_tracer_provider().shutdown() + + print("Traces sent successfully.") + + +if __name__ == "__main__": + main() diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.expected b/packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.expected new file mode 100644 index 00000000000..67afed9c4c8 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.expected @@ -0,0 +1,62 @@ +connectors: + forward: {} +exporters: + elasticsearch/componentid-0: + endpoints: + - https://elasticsearch:9200 +inputs: [] +output_permissions: + default: + _elastic_agent_checks: + cluster: + - monitor + _elastic_agent_monitoring: + indices: [] + uuid-for-permissions-on-related-indices: + indices: + - names: + - traces-*-* + privileges: + - auto_configure + - create_doc + - names: + - logs-generic.otel-* + privileges: + - auto_configure + - create_doc +processors: + resourcedetection/componentid-0: + detectors: + - system + transform/componentid-1: + trace_statements: + - context: span + statements: + - set(attributes["data_stream.type"], "traces") + - set(attributes["data_stream.dataset"], "jaegerreceiver") + - set(attributes["data_stream.namespace"], "ep") + - context: spanevent + statements: + - set(attributes["data_stream.type"], "logs") + - set(attributes["data_stream.namespace"], "ep") +receivers: + jaeger/componentid-0: + protocols: + grpc: + endpoint: 0.0.0.0:14260 +secret_references: [] +service: + pipelines: + traces: + exporters: + - elasticsearch/componentid-0 + receivers: + - forward + traces/componentid-0: + exporters: + - forward + processors: + - resourcedetection/componentid-0 + - transform/componentid-1 + receivers: + - jaeger/componentid-0 diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.yml b/packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.yml new file mode 100644 index 00000000000..fc290ab1075 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.yml @@ -0,0 +1,2 @@ +vars: + grpc_endpoint: "0.0.0.0:14260" diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-default.expected b/packages/jaeger_input_otel/_dev/test/policy/test-default.expected new file mode 100644 index 00000000000..4703a163edc --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-default.expected @@ -0,0 +1,62 @@ +connectors: + forward: {} +exporters: + elasticsearch/componentid-0: + endpoints: + - https://elasticsearch:9200 +inputs: [] +output_permissions: + default: + _elastic_agent_checks: + cluster: + - monitor + _elastic_agent_monitoring: + indices: [] + uuid-for-permissions-on-related-indices: + indices: + - names: + - traces-*-* + privileges: + - auto_configure + - create_doc + - names: + - logs-generic.otel-* + privileges: + - auto_configure + - create_doc +processors: + resourcedetection/componentid-0: + detectors: + - system + transform/componentid-1: + trace_statements: + - context: span + statements: + - set(attributes["data_stream.type"], "traces") + - set(attributes["data_stream.dataset"], "jaegerreceiver") + - set(attributes["data_stream.namespace"], "ep") + - context: spanevent + statements: + - set(attributes["data_stream.type"], "logs") + - set(attributes["data_stream.namespace"], "ep") +receivers: + jaeger/componentid-0: + protocols: + grpc: + endpoint: localhost:14250 +secret_references: [] +service: + pipelines: + traces: + exporters: + - elasticsearch/componentid-0 + receivers: + - forward + traces/componentid-0: + exporters: + - forward + processors: + - resourcedetection/componentid-0 + - transform/componentid-1 + receivers: + - jaeger/componentid-0 diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-default.yml b/packages/jaeger_input_otel/_dev/test/policy/test-default.yml new file mode 100644 index 00000000000..72b4ca320df --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-default.yml @@ -0,0 +1 @@ +vars: ~ diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http-tls.expected b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http-tls.expected new file mode 100644 index 00000000000..4d8fb9682e3 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http-tls.expected @@ -0,0 +1,72 @@ +connectors: + forward: {} +exporters: + elasticsearch/componentid-0: + endpoints: + - https://elasticsearch:9200 +inputs: [] +output_permissions: + default: + _elastic_agent_checks: + cluster: + - monitor + _elastic_agent_monitoring: + indices: [] + uuid-for-permissions-on-related-indices: + indices: + - names: + - traces-*-* + privileges: + - auto_configure + - create_doc + - names: + - logs-generic.otel-* + privileges: + - auto_configure + - create_doc +processors: + resourcedetection/componentid-0: + detectors: + - system + transform/componentid-1: + trace_statements: + - context: span + statements: + - set(attributes["data_stream.type"], "traces") + - set(attributes["data_stream.dataset"], "jaegerreceiver") + - set(attributes["data_stream.namespace"], "ep") + - context: spanevent + statements: + - set(attributes["data_stream.type"], "logs") + - set(attributes["data_stream.namespace"], "ep") +receivers: + jaeger/componentid-0: + protocols: + grpc: + endpoint: 0.0.0.0:14250 + tls: + cert_file: /path/to/server.crt + client_ca_file: /path/to/client-ca.crt + key_file: /path/to/server.key + thrift_http: + endpoint: 0.0.0.0:14268 + tls: + cert_file: /path/to/server.crt + client_ca_file: /path/to/client-ca.crt + key_file: /path/to/server.key +secret_references: [] +service: + pipelines: + traces: + exporters: + - elasticsearch/componentid-0 + receivers: + - forward + traces/componentid-0: + exporters: + - forward + processors: + - resourcedetection/componentid-0 + - transform/componentid-1 + receivers: + - jaeger/componentid-0 diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http-tls.yml b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http-tls.yml new file mode 100644 index 00000000000..57432e127ff --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http-tls.yml @@ -0,0 +1,7 @@ +vars: + grpc_endpoint: "0.0.0.0:14250" + thrift_http_endpoint: "0.0.0.0:14268" + tls_enabled: true + tls_cert_file: "/path/to/server.crt" + tls_key_file: "/path/to/server.key" + tls_client_ca_file: "/path/to/client-ca.crt" diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http.expected b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http.expected new file mode 100644 index 00000000000..8d970d2bb64 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http.expected @@ -0,0 +1,64 @@ +connectors: + forward: {} +exporters: + elasticsearch/componentid-0: + endpoints: + - https://elasticsearch:9200 +inputs: [] +output_permissions: + default: + _elastic_agent_checks: + cluster: + - monitor + _elastic_agent_monitoring: + indices: [] + uuid-for-permissions-on-related-indices: + indices: + - names: + - traces-*-* + privileges: + - auto_configure + - create_doc + - names: + - logs-generic.otel-* + privileges: + - auto_configure + - create_doc +processors: + resourcedetection/componentid-0: + detectors: + - system + transform/componentid-1: + trace_statements: + - context: span + statements: + - set(attributes["data_stream.type"], "traces") + - set(attributes["data_stream.dataset"], "jaegerreceiver") + - set(attributes["data_stream.namespace"], "ep") + - context: spanevent + statements: + - set(attributes["data_stream.type"], "logs") + - set(attributes["data_stream.namespace"], "ep") +receivers: + jaeger/componentid-0: + protocols: + grpc: + endpoint: localhost:14250 + thrift_http: + endpoint: 0.0.0.0:14268 +secret_references: [] +service: + pipelines: + traces: + exporters: + - elasticsearch/componentid-0 + receivers: + - forward + traces/componentid-0: + exporters: + - forward + processors: + - resourcedetection/componentid-0 + - transform/componentid-1 + receivers: + - jaeger/componentid-0 diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http.yml b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http.yml new file mode 100644 index 00000000000..239ad2d4242 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-thrift-http.yml @@ -0,0 +1,2 @@ +vars: + thrift_http_endpoint: "0.0.0.0:14268" diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-tls.expected b/packages/jaeger_input_otel/_dev/test/policy/test-tls.expected new file mode 100644 index 00000000000..9b9a398bd6b --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-tls.expected @@ -0,0 +1,66 @@ +connectors: + forward: {} +exporters: + elasticsearch/componentid-0: + endpoints: + - https://elasticsearch:9200 +inputs: [] +output_permissions: + default: + _elastic_agent_checks: + cluster: + - monitor + _elastic_agent_monitoring: + indices: [] + uuid-for-permissions-on-related-indices: + indices: + - names: + - traces-*-* + privileges: + - auto_configure + - create_doc + - names: + - logs-generic.otel-* + privileges: + - auto_configure + - create_doc +processors: + resourcedetection/componentid-0: + detectors: + - system + transform/componentid-1: + trace_statements: + - context: span + statements: + - set(attributes["data_stream.type"], "traces") + - set(attributes["data_stream.dataset"], "jaegerreceiver") + - set(attributes["data_stream.namespace"], "ep") + - context: spanevent + statements: + - set(attributes["data_stream.type"], "logs") + - set(attributes["data_stream.namespace"], "ep") +receivers: + jaeger/componentid-0: + protocols: + grpc: + endpoint: 0.0.0.0:14250 + tls: + cert_file: /path/to/server.crt + client_ca_file: /path/to/client-ca.crt + key_file: /path/to/server.key +secret_references: [] +service: + pipelines: + traces: + exporters: + - elasticsearch/componentid-0 + receivers: + - forward + traces/componentid-0: + exporters: + - forward + processors: + - resourcedetection/componentid-0 + - transform/componentid-1 + receivers: + - jaeger/componentid-0 diff --git a/packages/jaeger_input_otel/_dev/test/policy/test-tls.yml b/packages/jaeger_input_otel/_dev/test/policy/test-tls.yml new file mode 100644 index 00000000000..acb9c9cc6f4 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/policy/test-tls.yml @@ -0,0 +1,6 @@ +vars: + grpc_endpoint: "0.0.0.0:14250" + tls_enabled: true + tls_cert_file: "/path/to/server.crt" + tls_key_file: "/path/to/server.key" + tls_client_ca_file: "/path/to/client-ca.crt" diff --git a/packages/jaeger_input_otel/_dev/test/system/test-default-config.yml b/packages/jaeger_input_otel/_dev/test/system/test-default-config.yml new file mode 100644 index 00000000000..a5e80b9e3c3 --- /dev/null +++ b/packages/jaeger_input_otel/_dev/test/system/test-default-config.yml @@ -0,0 +1,7 @@ +service: jaeger_trace_sender +service_notify_signal: SIGHUP +vars: + grpc_endpoint: "0.0.0.0:14250" + thrift_http_endpoint: "0.0.0.0:14268" +assert: + min_count: 10 diff --git a/packages/jaeger_input_otel/agent/input/input.yml.hbs b/packages/jaeger_input_otel/agent/input/input.yml.hbs new file mode 100644 index 00000000000..780e9087faf --- /dev/null +++ b/packages/jaeger_input_otel/agent/input/input.yml.hbs @@ -0,0 +1,42 @@ +receivers: + jaeger: + protocols: + grpc: + endpoint: {{grpc_endpoint}} +{{#if tls_enabled}} + tls: +{{#if tls_cert_file}} + cert_file: {{tls_cert_file}} +{{/if}} +{{#if tls_key_file}} + key_file: {{tls_key_file}} +{{/if}} +{{#if tls_client_ca_file}} + client_ca_file: {{tls_client_ca_file}} +{{/if}} +{{/if}} +{{#if thrift_http_endpoint}} + thrift_http: + endpoint: {{thrift_http_endpoint}} +{{#if tls_enabled}} + tls: +{{#if tls_cert_file}} + cert_file: {{tls_cert_file}} +{{/if}} +{{#if tls_key_file}} + key_file: {{tls_key_file}} +{{/if}} +{{#if tls_client_ca_file}} + client_ca_file: {{tls_client_ca_file}} +{{/if}} +{{/if}} +{{/if}} + +processors: + resourcedetection/system: + detectors: ["system"] +service: + pipelines: + traces: + receivers: [jaeger] + processors: [resourcedetection/system] diff --git a/packages/jaeger_input_otel/changelog.yml b/packages/jaeger_input_otel/changelog.yml new file mode 100644 index 00000000000..46e351a1233 --- /dev/null +++ b/packages/jaeger_input_otel/changelog.yml @@ -0,0 +1,6 @@ +# newer versions go on top +- version: "0.1.0" + changes: + - description: Initial draft of the package + type: enhancement + link: https://github.com/elastic/integrations/pull/17231 \ No newline at end of file diff --git a/packages/jaeger_input_otel/docs/README.md b/packages/jaeger_input_otel/docs/README.md new file mode 100644 index 00000000000..f26babba052 --- /dev/null +++ b/packages/jaeger_input_otel/docs/README.md @@ -0,0 +1,25 @@ +# Jaeger OpenTelemetry Input Package + +## Overview +The Jaeger OpenTelemetry Input Package for Elastic enables collection of trace data in [Jaeger](https://www.jaegertracing.io/) format over **gRPC** using the [jaegerreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jaegerreceiver). + +**Jaeger and OpenTelemetry:** This input receives traces in **Jaeger format** (legacy Protobuf gRPC, Thrift HTTP), not OTLP. Jaeger and OpenTelemetry serve different roles—Jaeger is a tracing backend while OpenTelemetry provides SDKs for instrumentation; both support compatible trace models. For details on protocols, compatibility, and migration, see the [Jaeger documentation](https://www.jaegertracing.io/docs/2.15/) and the [jaegerreceiver README](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/jaegerreceiver/README.md). + +**Requirements:** Kibana 9.4.0 or later (traces support), Elastic Agent with Elastic Distribution of OpenTelemetry (EDOT). + +### How it works +This package receives trace data from Jaeger clients and agents by configuring the Jaeger gRPC receiver in the Input Package, which then gets applied to the jaegerreceiver present in the Elastic Distribution of OpenTelemetry (EDOT) collector, which then forwards the data to Elastic Agent. The Elastic Agent processes and enriches the data before sending it to Elasticsearch for indexing and analysis. + +### Protocols +Traces are received over gRPC (required) and optionally Thrift HTTP. + +| Setting | Default | Description | +|---------------|------------------|--------------------------------| +| **gRPC endpoint** | localhost:14250 | Listen address for Jaeger gRPC | +| **Thrift HTTP endpoint** | — | Optional. When set, enables Thrift HTTP (e.g. localhost:14268) for Jaeger agent compatibility | +| **Enable TLS** | false | Use TLS for secure gRPC connections | +| **TLS Certificate File** | — | Path to server certificate | +| **TLS Key File** | — | Path to server private key | +| **TLS Client CA File** | — | Path to CA for client verification (mTLS) | + +For protocol options, TLS/mTLS advanced configuration, and UDP protocols (thrift), refer to the [Jaeger Receiver README](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/jaegerreceiver/README.md) in the upstream OpenTelemetry Collector Contrib repository. diff --git a/packages/jaeger_input_otel/img/jaeger_otellogo.svg b/packages/jaeger_input_otel/img/jaeger_otellogo.svg new file mode 100644 index 00000000000..3645030aaf7 --- /dev/null +++ b/packages/jaeger_input_otel/img/jaeger_otellogo.svg @@ -0,0 +1,105 @@ + + + + Jaeger OpenTelemetry + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/packages/jaeger_input_otel/manifest.yml b/packages/jaeger_input_otel/manifest.yml new file mode 100644 index 00000000000..4aadcd83eb9 --- /dev/null +++ b/packages/jaeger_input_otel/manifest.yml @@ -0,0 +1,70 @@ +format_version: 3.5.0 +name: jaeger_input_otel +title: "Jaeger OpenTelemetry Input Package" +version: "0.1.0" +source: + license: "Elastic-2.0" +description: "Collect Jaeger traces over gRPC using the OpenTelemetry Collector." +type: input +categories: + - observability + - opentelemetry +conditions: + kibana: + version: "^9.4.0" + elastic: + subscription: "basic" +icons: + - src: /img/jaeger_otellogo.svg + title: Jaeger OpenTelemetry logo + size: 32x32 + type: image/svg+xml +policy_templates: + - name: jaegerreceiver + type: traces + title: Jaeger OpenTelemetry Input + description: Collect Jaeger traces using OpenTelemetry Collector + input: otelcol + template_path: input.yml.hbs + vars: + - name: grpc_endpoint + type: text + required: false + title: gRPC endpoint + description: Endpoint for the Jaeger gRPC protocol (default localhost:14250). + default: localhost:14250 + show_user: true + - name: tls_enabled + type: bool + required: false + title: Enable TLS + description: Enable TLS for secure gRPC and Thrift HTTP connections (certificate and key required). + default: false + show_user: true + - name: tls_cert_file + type: text + required: false + title: TLS Certificate File + description: Path to the TLS certificate file for the server. + show_user: true + - name: tls_key_file + type: text + required: false + title: TLS Key File + description: Path to the TLS private key file for the server. + show_user: true + - name: tls_client_ca_file + type: text + required: false + title: TLS Client CA File + description: Path to the CA certificate file for verifying client certificates (mTLS). + show_user: false + - name: thrift_http_endpoint + type: text + required: false + title: Thrift HTTP endpoint + description: Optional. Endpoint for the Jaeger Thrift HTTP protocol (e.g. localhost:14268). When set, enables HTTP alongside gRPC for Jaeger agent compatibility. + show_user: true +owner: + github: elastic/ecosystem + type: elastic diff --git a/packages/jaeger_input_otel/sample_event.json b/packages/jaeger_input_otel/sample_event.json new file mode 100644 index 00000000000..bb02aadb8c7 --- /dev/null +++ b/packages/jaeger_input_otel/sample_event.json @@ -0,0 +1,93 @@ +{ + "@timestamp": "2026-02-25T08:11:28.480Z", + "attributes": { + "otel": { + "library": { + "name": "jaeger-trace-sender", + "version": "1.0.0" + }, + "scope": { + "name": "jaeger-trace-sender", + "version": "1.0.0" + } + }, + "service": { + "name": "test-service" + }, + "telemetry": { + "sdk": { + "language": "python", + "name": "opentelemetry", + "version": "1.39.1" + } + } + }, + "data_stream": { + "dataset": "jaegerreceiver.otel", + "namespace": "44848", + "type": "traces" + }, + "duration": 105816000, + "event": { + "agent_id_status": "missing", + "dataset": "jaegerreceiver.otel", + "ingested": "2026-02-25T08:11:39Z" + }, + "host": { + "name": "elastic-agent-79793", + "os": { + "platform": "linux" + } + }, + "kind": "Internal", + "name": "child-span", + "os": { + "type": "linux" + }, + "otel": { + "library": { + "name": "jaeger-trace-sender", + "version": "1.0.0" + }, + "scope": { + "name": "jaeger-trace-sender", + "version": "1.0.0" + } + }, + "parent": { + "id": "5eaee0ad5dc76926" + }, + "parent_span_id": "5eaee0ad5dc76926", + "resource": { + "attributes": { + "host": { + "name": "elastic-agent-79793" + }, + "os": { + "type": "linux" + }, + "service": { + "name": "test-service" + } + }, + "schema_url": "https://opentelemetry.io/schemas/1.38.0" + }, + "service": { + "name": "test-service" + }, + "span": { + "id": "cd4e6467773039dd", + "name": "child-span" + }, + "span_id": "cd4e6467773039dd", + "telemetry": { + "sdk": { + "name": "opentelemetry", + "version": "1.39.1" + } + }, + "trace": { + "id": "b79a3bbdfbbce52550e4e84fb299a2ad" + }, + "trace_id": "b79a3bbdfbbce52550e4e84fb299a2ad" +}