diff --git a/examples/otelcollector/README.md b/examples/otelcollector/README.md new file mode 100644 index 0000000000..7c770bc18a --- /dev/null +++ b/examples/otelcollector/README.md @@ -0,0 +1,30 @@ +# Grafana Agent pull mode integration + +This example demonstrates how you can use Grafana Agent with Grafana Pyroscope to profile otel collector. + +### 1. Configure Grafana agent + +For Grafana Alloy to pull profiles from your application, configure the agent for things like profiling configuration, targets, and possibly authentication. + +You can find a list of [arguments](https://grafana.com/docs/agent/next/flow/reference/components/pyroscope.scrape/#arguments) and [supported blocks](https://grafana.com/docs/agent/next/flow/reference/components/pyroscope.scrape/#blocks) in the [Grafana Agent documentation for Pyroscope](https://grafana.com/docs/agent/next/flow/reference/components/pyroscope.scrape/) + +Refer to [config file](./agent/config/config.river) to see an example of how to configure Grafana Agent to send profiling data to Pyroscope. + +### 2. Run Grafana agent, Grafana, and Pyroscope + +```shell +docker-compose up -d +``` + +### 3. Observe profiling data + +Now that everything is set up, you can browse profiling data via [Grafana UI](http://localhost:3000). + +#### Explore view +For showing profiling data alongside traces +![image](https://github.com/grafana/pyroscope/assets/23323466/a9c2f28c-d35a-49b0-a3bc-678d3fbdd321) + +#### Dashboard +For showing real-time overview of profiling data +![image](https://github.com/grafana/pyroscope/assets/23323466/59a84d0c-87d2-4cfc-8e34-b54576cb6540) + diff --git a/examples/otelcollector/agent/config/agent.yaml b/examples/otelcollector/agent/config/agent.yaml new file mode 100644 index 0000000000..9faaad5f71 --- /dev/null +++ b/examples/otelcollector/agent/config/agent.yaml @@ -0,0 +1,2 @@ +server: + log_level: info diff --git a/examples/otelcollector/agent/config/config.river b/examples/otelcollector/agent/config/config.river new file mode 100644 index 0000000000..8b84a20da2 --- /dev/null +++ b/examples/otelcollector/agent/config/config.river @@ -0,0 +1,28 @@ +logging { + level = "debug" + format = "logfmt" +} + +pyroscope.write "example" { + // Send metrics to a locally running Phlare instance. + endpoint { + url = "http://pyroscope:4040" + + // To send data to Grafana Cloud you'll need to provide username and password. + // basic_auth { + // username = "myuser" + // password = "mypassword" + // } + } + external_labels = { + "env" = "example", + } +} + + +pyroscope.scrape "default" { + targets = [ + {"__address__" = "otelcollector:6060", "service_name"="otelcollector"}, + ] + forward_to = [pyroscope.write.example.receiver] +} diff --git a/examples/otelcollector/docker-compose.yml b/examples/otelcollector/docker-compose.yml new file mode 100644 index 0000000000..511639c964 --- /dev/null +++ b/examples/otelcollector/docker-compose.yml @@ -0,0 +1,41 @@ +version: '3.9' +services: + grafana: + image: grafana/grafana:latest + volumes: + - ./grafana-provisioning:/etc/grafana/provisioning + - ./grafana/grafana.ini:/etc/grafana/grafana.ini + - ./grafana/home.json:/default-dashboard.json + ports: + - 3000:3000 + + pyroscope: + image: 'grafana/pyroscope:1.0.0-rc.0' + ports: + - 4040:4040 + command: -config.file=/etc/pyroscope/config.yaml + volumes: + - ./pyroscope/config.yaml:/etc/pyroscope/config.yaml + + agent: + image: grafana/agent:latest + volumes: + - ./agent/config:/etc/agent-config + command: + - run + - /etc/agent-config/config.river + - --server.http.listen-addr=0.0.0.0:12345 + environment: + HOSTNAME: agent + AGENT_MODE: flow + ports: + - "12345:12345" + + otelcollector: + image: otel/opentelemetry-collector:0.67.0 + restart: always + command: ["--config=/etc/otelcollector.yaml"] + volumes: + - ./otelcollector.yaml:/etc/otelcollector.yaml + ports: + - "6060:6060" # pprof extension diff --git a/examples/otelcollector/grafana-provisioning/dashboards/main.json b/examples/otelcollector/grafana-provisioning/dashboards/main.json new file mode 100644 index 0000000000..5aeb3ca98b --- /dev/null +++ b/examples/otelcollector/grafana-provisioning/dashboards/main.json @@ -0,0 +1,71 @@ +{ + "annotations": { + "list": [] + }, + "editable": true, + "fiscalYearStartMonth": 0, + "graphTooltip": 1, + "links": [], + "liveNow": false, + "panels": [ + { + "datasource": { + "type": "phlare", + "uid": "pyroscope" + }, + "gridPos": { + "h": 19, + "w": 24, + "x": 0, + "y": 0 + }, + "id": 1, + "targets": [ + { + "datasource": { + "type": "phlare", + "uid": "pyroscope" + }, + "groupBy": [], + "labelSelector": "{}", + "profileTypeId": "process_cpu:cpu:nanoseconds:cpu:nanoseconds", + "queryType": "profile", + "refId": "A" + } + ], + "title": "Panel Title", + "type": "flamegraph" + } + ], + "refresh": "5s", + "schemaVersion": 38, + "style": "dark", + "tags": [], + "templating": { + "list": [] + }, + "time": { + "from": "now-15m", + "to": "now" + }, + "timepicker": { + "refresh_intervals": [ + "5s", + "10s", + "30s", + "1m", + "5m", + "15m", + "30m", + "1h", + "2h", + "1d" + ], + "time_options": ["5m", "15m", "1h", "6h", "12h", "24h", "2d", "7d", "30d"] + }, + "timezone": "browser", + "title": "main", + "uid": "65gjqY3Mk", + "version": 1, + "weekStart": "" +} diff --git a/examples/otelcollector/grafana-provisioning/dashboards/main.yml b/examples/otelcollector/grafana-provisioning/dashboards/main.yml new file mode 100644 index 0000000000..736aa1f750 --- /dev/null +++ b/examples/otelcollector/grafana-provisioning/dashboards/main.yml @@ -0,0 +1,8 @@ +apiVersion: 1 + +providers: + - name: dashboards + type: file + updateIntervalSeconds: 5 + options: + path: /etc/grafana/provisioning/dashboards diff --git a/examples/otelcollector/grafana-provisioning/datasources/datasources.yml b/examples/otelcollector/grafana-provisioning/datasources/datasources.yml new file mode 100644 index 0000000000..195b8499e4 --- /dev/null +++ b/examples/otelcollector/grafana-provisioning/datasources/datasources.yml @@ -0,0 +1,12 @@ +--- +apiVersion: 1 +datasources: + - name: Pyroscope + orgId: 1 + uid: pyroscope + type: 'phlare' + access: 'proxy' + grafanaOrgId: 1 + url: http://pyroscope:4040 + isDefault: true + editable: true diff --git a/examples/otelcollector/grafana/grafana.ini b/examples/otelcollector/grafana/grafana.ini new file mode 100644 index 0000000000..65cc3376e0 --- /dev/null +++ b/examples/otelcollector/grafana/grafana.ini @@ -0,0 +1,975 @@ +##################### Grafana Configuration Example ##################### +# +# Everything has defaults so you only need to uncomment things you want to +# change + +# possible values : production, development +;app_mode = production + +# instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty +;instance_name = ${HOSTNAME} + +#################################### Paths #################################### +[paths] +# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used) +;data = /var/lib/grafana + +# Temporary files in `data` directory older than given duration will be removed +;temp_data_lifetime = 24h + +# Directory where grafana can store logs +;logs = /var/log/grafana + +# Directory where grafana will automatically scan and look for plugins +;plugins = /var/lib/grafana/plugins + +# folder that contains provisioning config files that grafana will apply on startup and while running. +provisioning = /etc/grafana/provisioning + +#################################### Server #################################### +[server] +# Protocol (http, https, h2, socket) +;protocol = http + +# The ip address to bind to, empty will bind to all interfaces +;http_addr = + +# The http port to use +;http_port = 3000 + +# The public facing domain name used to access grafana from a browser +;domain = localhost + +# Redirect to correct domain if host header does not match domain +# Prevents DNS rebinding attacks +;enforce_domain = false + +# The full public facing url you use in browser, used for redirects and emails +# If you use reverse proxy and sub path specify full url (with sub path) +;root_url = %(protocol)s://%(domain)s:%(http_port)s/ + +# Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons. +;serve_from_sub_path = false + +# Log web requests +;router_logging = false + +# the path relative working path +;static_root_path = public + +# enable gzip +;enable_gzip = false + +# https certs & key file +;cert_file = +;cert_key = + +# Unix socket path +;socket = + +# CDN Url +;cdn_url = + +# Sets the maximum time using a duration format (5s/5m/5ms) before timing out read of an incoming request and closing idle connections. +# `0` means there is no timeout for reading the request. +;read_timeout = 0 + +#################################### Database #################################### +[database] +# You can configure the database connection by specifying type, host, name, user and password +# as separate properties or as on string using the url properties. + +# Either "mysql", "postgres" or "sqlite3", it's your choice +;type = sqlite3 +;host = 127.0.0.1:3306 +;name = grafana +;user = root +# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;""" +;password = + +# Use either URL or the previous fields to configure the database +# Example: mysql://user:secret@host:port/database +;url = + +# For "postgres" only, either "disable", "require" or "verify-full" +;ssl_mode = disable + +# Database drivers may support different transaction isolation levels. +# Currently, only "mysql" driver supports isolation levels. +# If the value is empty - driver's default isolation level is applied. +# For "mysql" use "READ-UNCOMMITTED", "READ-COMMITTED", "REPEATABLE-READ" or "SERIALIZABLE". +;isolation_level = + +;ca_cert_path = +;client_key_path = +;client_cert_path = +;server_cert_name = + +# For "sqlite3" only, path relative to data_path setting +;path = grafana.db + +# Max idle conn setting default is 2 +;max_idle_conn = 2 + +# Max conn setting default is 0 (mean not set) +;max_open_conn = + +# Connection Max Lifetime default is 14400 (means 14400 seconds or 4 hours) +;conn_max_lifetime = 14400 + +# Set to true to log the sql calls and execution times. +;log_queries = + +# For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared) +;cache_mode = private + +################################### Data sources ######################### +[datasources] +# Upper limit of data sources that Grafana will return. This limit is a temporary configuration and it will be deprecated when pagination will be introduced on the list data sources API. +;datasource_limit = 5000 + +#################################### Cache server ############################# +[remote_cache] +# Either "redis", "memcached" or "database" default is "database" +;type = database + +# cache connectionstring options +# database: will use Grafana primary database. +# redis: config like redis server e.g. `addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false`. Only addr is required. ssl may be 'true', 'false', or 'insecure'. +# memcache: 127.0.0.1:11211 +;connstr = + +#################################### Data proxy ########################### +[dataproxy] + +# This enables data proxy logging, default is false +;logging = false + +# How long the data proxy waits to read the headers of the response before timing out, default is 30 seconds. +# This setting also applies to core backend HTTP data sources where query requests use an HTTP client with timeout set. +;timeout = 30 + +# How long the data proxy waits to establish a TCP connection before timing out, default is 10 seconds. +;dialTimeout = 10 + +# How many seconds the data proxy waits before sending a keepalive probe request. +;keep_alive_seconds = 30 + +# How many seconds the data proxy waits for a successful TLS Handshake before timing out. +;tls_handshake_timeout_seconds = 10 + +# How many seconds the data proxy will wait for a server's first response headers after +# fully writing the request headers if the request has an "Expect: 100-continue" +# header. A value of 0 will result in the body being sent immediately, without +# waiting for the server to approve. +;expect_continue_timeout_seconds = 1 + +# The maximum number of idle connections that Grafana will keep alive. +;max_idle_connections = 100 + +# The maximum number of idle connections per host that Grafana will keep alive. +;max_idle_connections_per_host = 2 + +# How many seconds the data proxy keeps an idle connection open before timing out. +;idle_conn_timeout_seconds = 90 + +# If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request, default is false. +;send_user_header = false + +#################################### Analytics #################################### +[analytics] +# Server reporting, sends usage counters to stats.grafana.org every 24 hours. +# No ip addresses are being tracked, only simple counters to track +# running instances, dashboard and error counts. It is very helpful to us. +# Change this option to false to disable reporting. +;reporting_enabled = true + +# The name of the distributor of the Grafana instance. Ex hosted-grafana, grafana-labs +;reporting_distributor = grafana-labs + +# Set to false to disable all checks to https://grafana.net +# for new versions (grafana itself and plugins), check is used +# in some UI views to notify that grafana or plugin update exists +# This option does not cause any auto updates, nor send any information +# only a GET request to http://grafana.com to get latest versions +;check_for_updates = true + +# Google Analytics universal tracking code, only enabled if you specify an id here +;google_analytics_ua_id = + +# Google Tag Manager ID, only enabled if you specify an id here +;google_tag_manager_id = + +#################################### Security #################################### +[security] +# disable creation of admin user on first start of grafana +;disable_initial_admin_creation = false + +# default admin user, created on startup +;admin_user = admin + +# default admin password, can be changed before first start of grafana, or in profile settings +;admin_password = admin + +# used for signing +;secret_key = SW2YcwTIb9zpOOhoPsMm + +# disable gravatar profile images +;disable_gravatar = false + +# data source proxy whitelist (ip_or_domain:port separated by spaces) +;data_source_proxy_whitelist = + +# disable protection against brute force login attempts +;disable_brute_force_login_protection = false + +# set to true if you host Grafana behind HTTPS. default is false. +;cookie_secure = false + +# set cookie SameSite attribute. defaults to `lax`. can be set to "lax", "strict", "none" and "disabled" +;cookie_samesite = lax + +# set to true if you want to allow browsers to render Grafana in a ,