-
Notifications
You must be signed in to change notification settings - Fork 308
processcontext: add ProcessContext message from OTEP 4719
#783
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
Open
ivoanjo
wants to merge
7
commits into
open-telemetry:main
Choose a base branch
from
ivoanjo:ivoanjo/profiling-process-ctx
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.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
06f97c8
Add `ProcessContext` message from OTEP 4719
ivoanjo 3bc1473
Update changelog
ivoanjo e6f6fa7
Apply suggestion from @florianl
ivoanjo ec83a05
Minor: Simplify resource comment description to match profiles.proto
ivoanjo bc5dc57
Merge remote-tracking branch 'origin/main' into ivoanjo/profiling-pro…
ivoanjo aaf50b5
Merge remote-tracking branch 'origin/main' into ivoanjo/profiling-pro…
ivoanjo 7c6b766
Update repository docs to open scope slightly to other OTel protos
ivoanjo 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
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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Process Context | ||
|
|
||
| **Status:** [Development](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md) | ||
|
|
||
| ProcessContext is a non-OTLP protocol for sharing process-level OpenTelemetry | ||
| resource attributes with external readers (e.g. the | ||
| [OpenTelemetry eBPF Profiler](https://github.com/open-telemetry/opentelemetry-ebpf-profiler)). | ||
|
|
||
| This page is a quick orientation; the normative specification lives in | ||
| [OTEP 4719][otep]. | ||
|
|
||
| ## Relationship to OTLP | ||
|
|
||
| ProcessContext is **not** part of OTLP: | ||
|
|
||
| - It is not exchanged via gRPC or HTTP. | ||
| - It does not pass through the OpenTelemetry Collector. | ||
| - It carries only process-scoped resource attributes, not telemetry data. | ||
|
|
||
| It lives in this repository because it shares OTLP's `common` and `resource` | ||
| proto types and benefits from the same versioning and release machinery. | ||
|
|
||
| [otep]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/oteps/profiles/4719-process-ctx.md |
54 changes: 54 additions & 0 deletions
54
opentelemetry/proto/processcontext/v1development/process_context.proto
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,54 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package opentelemetry.proto.processcontext.v1development; | ||
|
|
||
| import "opentelemetry/proto/common/v1/common.proto"; | ||
| import "opentelemetry/proto/resource/v1/resource.proto"; | ||
|
|
||
| option csharp_namespace = "OpenTelemetry.Proto.ProcessContext.V1Development"; | ||
| option java_multiple_files = true; | ||
| option java_package = "io.opentelemetry.proto.processcontext.v1development"; | ||
| option java_outer_classname = "ProcessContextProto"; | ||
| option go_package = "go.opentelemetry.io/proto/otlp/processcontext/v1development"; | ||
|
|
||
| // ProcessContext represents the payload for the process context sharing mechanism. | ||
| // | ||
| // This message is designed to be published by OpenTelemetry SDKs via a memory-mapped | ||
| // region, allowing external readers (such as the OpenTelemetry eBPF Profiler) to | ||
| // discover and read resource attributes from instrumented processes without requiring | ||
| // direct integration or process activity. It is not part of OTLP and is not | ||
| // exchanged via the OpenTelemetry Collector. | ||
| // | ||
| // See OTEP 4719 for details of this mechanism. | ||
| // | ||
| // Status: [Development] | ||
| message ProcessContext { | ||
| // The resource for this process. | ||
| // If this field is not set then no resource info is known. | ||
| opentelemetry.proto.resource.v1.Resource resource = 1; | ||
|
|
||
| // Additional attributes to share with external readers that are not part of | ||
| // the standard Resource. [Optional] | ||
| // | ||
| // This field allows publishers to include supplementary key-value pairs that | ||
| // may be useful for external readers but are not part of the SDK's configured | ||
| // Resource. | ||
| // | ||
| // Consider adding any keys here to the profiles semantic conventions in | ||
| // https://opentelemetry.io/docs/specs/semconv/general/profiles/ | ||
| repeated opentelemetry.proto.common.v1.KeyValue attributes = 2; | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.