-
Notifications
You must be signed in to change notification settings - Fork 39
OCI APM Support with Traceloop library #68
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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,61 @@ | ||
--- | ||
title: "LLM Observability with Oracle Cloud Infrastructure Application Performance Monitoring(APM) service" | ||
sidebarTitle: "OCI Application Performance Monitoring" | ||
--- | ||
|
||
<Frame> | ||
<img src="/img/integrations/ociapm-traceexplorer.png" /> | ||
</Frame> | ||
|
||
|
||
[Oracle Cloud Infrastructure Application Performance Monitoring(APM) service](https://docs.oracle.com/en-us/iaas/application-performance-monitoring/home.htm) natively supports and can ingest OpenTelemetry (OTLP) spans and metrics. Traceloop's OpenLLMetry library enables instrumenting LLM frameworks and applications in Open Telemetry format and can be routed to OCI Application Performance Monitoring for observability and evaluation of LLM applications. | ||
|
||
## Initialize and export directly from application code | ||
|
||
```python | ||
APM_BASE_URL=“<OCI APM dataUploadEndpoint>/20200101/opentelemetry/private" | ||
APM_DATA_KEY="datakey <OCI APM Private Data Key>" | ||
APM_SERVICE_NAME=“My LLM Service” | ||
|
||
Traceloop.init( | ||
disable_batch=True, | ||
app_name=APM_SERVICE_NAME, | ||
api_endpoint=APM_BASE_URL, | ||
headers={ | ||
"Authorization": APM_DATA_KEY | ||
} | ||
) | ||
``` | ||
|
||
## Initialize using environment variables | ||
|
||
```bash | ||
export TRACELOOP_BASE_URL=<OCI APM dataUploadEndpoint>/20200101/opentelemetry/private | ||
export TRACELOOP_HEADERS="Authorization=dataKey <OCI APM Private Data Key>" | ||
``` | ||
|
||
## Using an OpenTelemetry Collector | ||
If you are using an OpenTelemetry Collector, you can route metrics and traces to OCI APM by simply adding an OTLP exporter to your collector configuration. | ||
|
||
```yaml | ||
receivers: | ||
otlp: | ||
protocols: | ||
http: | ||
endpoint: 0.0.0.0:4318 | ||
processors: | ||
batch: | ||
exporters: | ||
otlphttp/apm: | ||
endpoint: "<OCI APM dataUploadEndpoint>/20200101/opentelemetry/private" | ||
headers: | ||
"Authorization": "dataKey <OCI APM Private Data Key>" | ||
service: | ||
pipelines: | ||
traces: | ||
receivers: [otlp] | ||
processors: [batch] | ||
exporters: [otlphttp/apm] | ||
``` | ||
|
||
For more information check out the [docs link](https://docs.oracle.com/en-us/iaas/application-performance-monitoring/doc/configure-open-source-tracing-systems.html#GUID-4D941163-F357-4839-8B06-688876D4C61F). |
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.
Ensure consistent casing for data key (e.g.,
datakey
vsdataKey
) across examples.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.
@ellipsis-dev
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.
@Anand-GitH, I have addressed your comments in pull request #69
You can configure Ellipsis to address comments with a direct commit or a side PR, see docs.