-
Notifications
You must be signed in to change notification settings - Fork 554
Jaeger OTel input package #17231
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
teresaromero
wants to merge
9
commits into
elastic:main
Choose a base branch
from
teresaromero:17137-jaeger-input
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Jaeger OTel input package #17231
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
00c9d94
add Jaeger OpenTelemetry Input Package
teresaromero 65760ae
set initial package config to grpc, remove unsupported protocols docs…
teresaromero 85704f2
add docker-compose configuration and default test settings for jaeger…
teresaromero 2e3e955
Merge branch 'main' of github.com:elastic/integrations into 17137-jae…
teresaromero f988ea0
Update Jaeger OpenTelemetry Input Package with TLS and Thrift HTTP su…
teresaromero e0106b1
Add sample event JSON and update Docker deployment for Jaeger OpenTel…
teresaromero 1e3cb30
Merge branch 'main' of github.com:elastic/integrations into 17137-jae…
teresaromero 92a7461
Update CODEOWNERS and issue templates to reflect Jaeger OpenTelemetry…
teresaromero d5ea8c4
Enhance Jaeger OpenTelemetry Input Package with TLS and Thrift HTTP s…
teresaromero File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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] | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 MEDIUM Alphabetical ordering Why: Same as bug template - Jaeger should be placed after Istio, not after IIS entries.
Suggested change
Why is Claude responding? | Type Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not. |
||||||||||
| - Imperva Cloud WAF [imperva_cloud_waf] | ||||||||||
| - Imperva [imperva] | ||||||||||
| - InfluxDb [influxdb] | ||||||||||
|
|
||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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"] |
7 changes: 7 additions & 0 deletions
7
packages/jaeger_input_otel/_dev/deploy/docker/docker-compose.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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"] |
5 changes: 5 additions & 0 deletions
5
packages/jaeger_input_otel/_dev/deploy/docker/requirements.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
71 changes: 71 additions & 0 deletions
71
packages/jaeger_input_otel/_dev/deploy/docker/scripts/send_jaeger_traces.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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() |
62 changes: 62 additions & 0 deletions
62
packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.expected
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
2 changes: 2 additions & 0 deletions
2
packages/jaeger_input_otel/_dev/test/policy/test-custom-endpoint.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| vars: | ||
| grpc_endpoint: "0.0.0.0:14260" |
62 changes: 62 additions & 0 deletions
62
packages/jaeger_input_otel/_dev/test/policy/test-default.expected
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| vars: ~ |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 MEDIUM Alphabetical ordering
Why: Jaeger should be placed after Istio (line 226), not after IIS entries. The file is sorted alphabetically by integration name.
Why is Claude responding? | Type
@claudeto interact furtherGive us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.