Skip to content

Commit

Permalink
pyroscope client extension
Browse files Browse the repository at this point in the history
  • Loading branch information
akvlad committed Aug 23, 2024
1 parent d6d8a01 commit e13ca34
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
42 changes: 42 additions & 0 deletions extension/pyroscope/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Pyroscope client

| Status | |
|---------------------------|--------|
| Stability | [beta] |


The Extension provides the functionality to export the opentelementry collector profiles into a pyroscope compatible
server.


The following settings can be configured:

- application_name (default = "opentelemetry-collector"): The name of the application as it will appear in Pyroscope.
- tags (default = empty map): A map of key-value pairs for additional tags to be associated with the profiles.
- server_address (default = "http://localhost:8062"): The URL of the Pyroscope server to which the profiles will be sent.
- basic_auth (default = empty): Basic authentication configuration for connecting to the Pyroscope server.
- username: The username for basic authentication.
- password: The password for basic authentication.
- profile_types (default = ["cpu", "alloc_objects", "alloc_space", "inuse_objects", "inuse_space"]):
An array of profile types to collect and send to Pyroscope.
- tenant_id (default = ""): The tenant ID to use when sending profiles to Pyroscope, for multi-tenancy support.

Example:
```yaml
extensions:
pyroscope:
application_name: "my-collector"
tags:
environment: "production"
region: "us-west-2"
server_address: "http://localhost:8062"
basic_auth:
username: "user"
password: "secret"
profile_types:
- "cpu"
- "alloc_objects"
- "inuse_space"
service:
extensions: [pyroscope]
```
1 change: 1 addition & 0 deletions extension/pyroscope/extension.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package pyroscope

import (
"context"

"github.com/google/uuid"
"github.com/grafana/pyroscope-go"
"go.opentelemetry.io/collector/component"
Expand Down

0 comments on commit e13ca34

Please sign in to comment.