-
Notifications
You must be signed in to change notification settings - Fork 18
Add OpAMP support #782
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
Merged
Merged
Add OpAMP support #782
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
248eb31
Add provisional OpAMP impl
pmcollins 4126c9e
Use oteltest OpAMP server in integration test
pmcollins e9a031b
Handle OpAMP resource attribute arrays
pmcollins 746b8dd
Update docs for OpAMP support
pmcollins da0caf5
Clarify OpAMP changelog entry
pmcollins f81d8e5
Sanitize OpAMP reported endpoints
pmcollins 830723c
Validate OpAMP polling interval
pmcollins 148649c
Simplify OpAMP integration test synchronization
pmcollins 376b68c
Format OpAMP tests
pmcollins cde6cb8
Sanitize logged OpAMP endpoint
pmcollins 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 |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # OpAMP | ||
|
|
||
| Splunk OTel Python provides OpAMP support. When enabled, the OpAMP client | ||
| connects to the configured endpoint and reports the Python agent's status and | ||
| settings. Agents connected to Splunk Observability Cloud appear on the Fleet | ||
| Management page. | ||
|
|
||
| OpAMP support is provisional. Remote configuration is not supported yet. | ||
|
|
||
| ## Default connection | ||
|
|
||
| ```text | ||
| Python process -> Splunk OpenTelemetry Collector -> Splunk Observability Cloud | ||
| ``` | ||
|
|
||
| The Python process sends OpAMP messages to | ||
| `http://localhost:4320/v1/opamp` by default. The collector must listen on that | ||
| address and forward the messages to Splunk Observability Cloud. | ||
|
|
||
| ## Enable OpAMP | ||
|
|
||
| ```sh | ||
| SPLUNK_OPAMP_ENABLED=true \ | ||
| opentelemetry-instrument python app.py | ||
| ``` | ||
|
|
||
| ## Settings | ||
|
|
||
| | Environment variable | Default | Description | | ||
| |------------------------------------|------------------------------------|--------------------------------| | ||
| | `SPLUNK_OPAMP_ENABLED` | `false` | Set to `true` to enable OpAMP. | | ||
| | `SPLUNK_OPAMP_ENDPOINT` | `http://localhost:4320/v1/opamp` | OpAMP endpoint. | | ||
| | `SPLUNK_OPAMP_POLLING_INTERVAL` | `30000` | Report interval, in milliseconds. | | ||
|
|
||
|
|
||
| ## Troubleshooting | ||
|
|
||
| Open **Data Management > Fleet Management > Instrumentation** in Splunk | ||
| Observability Cloud. If OpAMP is enabled, the Python agent should show `Connected`. | ||
|
|
||
| If it does not: | ||
|
|
||
| - When using the default endpoint, check that the collector listens on port `4320`. | ||
| - Check the collector endpoint and access token. | ||
| - Check the application logs for `Connection to OpAMP server failed`. |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.