-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Weifeng Wang <qclaogui@gmail.com> From Agent to Alloy Signed-off-by: Weifeng Wang <qclaogui@gmail.com>
- Loading branch information
Showing
16 changed files
with
2,116 additions
and
3 deletions.
There are no files selected for viewing
This file contains 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 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,38 @@ | ||
| services: | ||
| alloy: | ||
| labels: | ||
| logs.agent.grafana.com/log-format: logfmt | ||
| depends_on: { gateway: { condition: service_healthy } } | ||
| image: ${ALLOY_IMAGE:-docker.io/grafana/alloy:v1.0.0} | ||
| volumes: | ||
| - ../config/alloy:/etc/alloy | ||
| - /var/run/docker.sock:/var/run/docker.sock:ro | ||
| - /:/rootfs:ro | ||
| - /sys:/sys:ro | ||
| - /var/lib/docker:/var/lib/docker:ro | ||
| entrypoint: | ||
| - /bin/alloy | ||
| - run | ||
| - /etc/alloy/metrics.alloy | ||
| - --server.http.listen-addr=0.0.0.0:12345 | ||
| - --storage.path=/var/lib/alloy/data | ||
| - --cluster.enabled=true | ||
| - --cluster.join-addresses=alloy-cluster:12345 | ||
| - --disable-reporting=true | ||
| - --stability.level=experimental | ||
| environment: | ||
| - ALLOY_CONFIG_FOLDER=/etc/alloy | ||
| healthcheck: | ||
| test: [ "CMD-SHELL", "wget --no-verbose --tries=1 --spider http://localhost:12345/ready || exit 1" ] | ||
| interval: 5s | ||
| timeout: 2s | ||
| retries: 10 | ||
| ports: | ||
| - "12345-12348:12345" | ||
| deploy: | ||
| # Note: max replicas num is 3. | ||
| replicas: 1 | ||
| networks: | ||
| default: | ||
| aliases: | ||
| - alloy-cluster |
This file contains 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 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,55 @@ | ||
| logging { | ||
| level = coalesce(env("ALLOY_LOG_LEVEL"), "info") | ||
| format = "logfmt" | ||
| } | ||
|
|
||
| /******************************************** | ||
| * Grafana LGTMP Stack Receiver Provider | ||
| ********************************************/ | ||
| import.file "provider" { | ||
| filename = coalesce(env("ALLOY_CONFIG_FOLDER"), "/etc/alloy") + "/modules/provider" | ||
| } | ||
|
|
||
| // get receiver provider | ||
| provider.self_host "docker_compose" { | ||
| metrics_endpoint = "http://gateway:8080" | ||
| } | ||
|
|
||
| // import docker compose modules | ||
| import.file "docker_compose" { | ||
| filename = coalesce(env("ALLOY_CONFIG_FOLDER"), "/etc/alloy") + "/modules/docker/compose" | ||
| } | ||
|
|
||
| /******************************************** | ||
| * Metrics | ||
| ********************************************/ | ||
|
|
||
| // targets auto scrape by docker compose label | ||
| docker_compose.metrics_auto_scrape "default" { | ||
| forward_to = [provider.self_host.docker_compose.metrics_receiver] | ||
| scrape_interval = "15s" | ||
| } | ||
|
|
||
| // minio v3 metrics | ||
| import.file "jobs" { | ||
| filename = coalesce(env("ALLOY_CONFIG_FOLDER"), "/etc/alloy") + "/modules/docker/metrics/jobs/minio.alloy" | ||
| } | ||
|
|
||
| jobs.scrape_minio "deafult" { | ||
| forward_to = [provider.self_host.docker_compose.metrics_receiver] | ||
| scrape_interval = "15s" | ||
| } | ||
|
|
||
| import.file "integration_jobs" { | ||
| filename = coalesce(env("ALLOY_CONFIG_FOLDER"), "/etc/alloy") + "/modules/docker/metrics/jobs/integrations" | ||
| } | ||
|
|
||
| integration_jobs.scrape_cadvisor "deafult" { | ||
| forward_to = [provider.self_host.docker_compose.metrics_receiver] | ||
| scrape_interval = "15s" | ||
| } | ||
|
|
||
| integration_jobs.scrape_node_exporter "deafult" { | ||
| forward_to = [provider.self_host.docker_compose.metrics_receiver] | ||
| scrape_interval = "15s" | ||
| } |
60 changes: 60 additions & 0 deletions
60
docker-compose/common/config/alloy/modules/docker/README.md
This file contains 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,60 @@ | ||
| # Docker Compose Modules | ||
|
|
||
| ## Logs | ||
|
|
||
| The following service labels are supported: | ||
|
|
||
| | Label | Description | | ||
| | :--------------- | :-----------| | ||
| | `logs.agent.grafana.com/scrape` | Allow a service to declare it's logs should be ingested (default is `true`). | | ||
| | `logs.agent.grafana.com/tenant` | Allow a service to override the tenant for its logs. | | ||
| | `logs.agent.grafana.com/log-format` | If specified additional processing is performed to extract details based on the specified format. This value can be a comma-delimited list, in the instances a pod may have multiple containers. The following formats are currently supported: <ul><li>common-log<li>donet<li>istio<li>json<li>klog<li>log4j-json<li>logfmt<li>otel<li>postgres<li>python<li>spring-boot<li>syslog<li>zerolog</ul> | | ||
| | `logs.agent.grafana.com/scrub-level` | Boolean whether or not the level should be dropped from the log message (as it is a label). | | ||
| | `logs.agent.grafana.com/scrub-timestamp` | Boolean whether or not the timestamp should be dropped from the log message (as it is metadata). | | ||
| | `logs.agent.grafana.com/scrub-nulls` | Boolean whether or not keys with null values should be dropped from json, reducing the size of the log message. | | ||
| | `logs.agent.grafana.com/scrub-empties` | Boolean whether or not keys with empty values (`"", [], {}`) should be dropped from json, reducing the size of the log message. | | ||
| | `logs.agent.grafana.com/drop-info` | Boolean whether or not info messages should be dropped (default is `false`), but a pod can override this temporarily or permanently. | | ||
| | `logs.agent.grafana.com/drop-debug` | Boolean whether or not debug messages should be dropped (default is `true`), but a pod can override this temporarily or permanently. | | ||
| | `logs.agent.grafana.com/drop-trace` | Boolean whether or not trace messages should be dropped (default is `true`), but a pod can override this temporarily or permanently. | | ||
| | `logs.agent.grafana.com/mask-ssn` | Boolean whether or not to mask SSNs in the log line, if true the data will be masked as `*SSN*salt*` | | ||
| | `logs.agent.grafana.com/mask-credit-card` | Boolean whether or not to mask credit cards in the log line, if true the data will be masked as `*credit-card*salt*` | | ||
| | `logs.agent.grafana.com/mask-email` | Boolean whether or not to mask emails in the log line, if true the data will be masked as`*email*salt*` | | ||
| | `logs.agent.grafana.com/mask-ipv4` | Boolean whether or not to mask IPv4 addresses in the log line, if true the data will be masked as`*ipv4*salt*` | | ||
| | `logs.agent.grafana.com/mask-ipv6` | Boolean whether or not to mask IPv6 addresses in the log line, if true the data will be masked as `*ipv6*salt*` | | ||
| | `logs.agent.grafana.com/mask-phone` | Boolean whether or not to mask phone numbers in the log line, if true the data will be masked as `*phone*salt*` | | ||
|
|
||
| --- | ||
|
|
||
| ## Metrics | ||
|
|
||
| The following service labels are supported for gathering of metrics for docker compose services: | ||
|
|
||
| | Label | Description | | ||
| | :--------------- | :-----------| | ||
| | `metrics.agent.grafana.com/scrape` <br>or<br> `prometheus.io/scrape` | Boolean whether or not to scrape the service for metrics (default is `true`).| | ||
| | `metrics.agent.grafana.com/scheme` <br>or<br> `prometheus.io/scheme` | The default scraping scheme is `http`, only support `http` now. | | ||
| | `metrics.agent.grafana.com/path` <br>or<br> `prometheus.io/path` | the default path to scrape is `/metrics`, this can be specified as a single value which would override, the scrape path being used for all ports attached to the target | | ||
| | `metrics.agent.grafana.com/port` <br>or<br> `prometheus.io/port` | the default `port` to scrape is the target port, this can be specified as a single value which would override the scrape port being used for all ports attached to the target, note that even if an target had multiple targets, the relabel_config targets are deduped before scraping | | ||
| | `metrics.agent.grafana.com/tenant` | The tenant their metrics should be sent to, this does not necessarily have to be the actual tenantId, it can be a friendly name as well that is simply used to determine if the metrics should be gathered for the current tenant | | ||
| | `metrics.agent.grafana.com/job` <br>or<br> `prometheus.io/job` | The job label value to use when collecting their metrics. However, it is common to use an integration or community project where rules / dashboards are provided for you. Oftentimes, this provided assets use hard-coded values for a job label i.e. `...{job="integrations/kubernetes/cadvisor"...}` or `...{job="minio-job"...}` setting this annotation to that value will allow the provided asset to work out of the box. | | ||
| | `metrics.agent.grafana.com/interval` <br>or<br> `prometheus.io/interval` | The default interval to scrape is `15s`, this can be override. | | ||
| | `metrics.agent.grafana.com/timeout` <br>or<br> `prometheus.io/timeout` | The default timeout for scraping is `10s`, this can be override. | | ||
|
|
||
| --- | ||
|
|
||
| ## Profiles | ||
|
|
||
| The following service labels are supported for docker compose services: | ||
|
|
||
| > The full list of profile types supported by labels is `cpu`, `memory`, `goroutine`, `block`, `mutex` and `fgprof`: | ||
| | Label | Description | | ||
| | :--------------- | :-----------| | ||
| | `profiles.agent.grafana.com/service_name` <br>or<br> `profiles.grafana.com/service_name` <br>or<br> `pyroscope.io/service_name` | The special label `service_name` is required and must always be present. If it is not specified, will attempt to infer it from either of the following sources. in this order: <ul><li>1. `__meta_docker_container_label_profiles_agent_grafana_com_service_name` which is a `profiles.agent.grafana.com/service_name` service label<li>2. `__meta_docker_container_label_profiles_grafana_com_service_name` which is a `profiles.grafana.com/service_name` service label<li>3. `__meta_docker_container_label_pyroscope_io_service_name` which is a `pyroscope.io/service_name` service label<li>4. `__meta_docker_container_name`</ul>| | ||
| | `profiles.agent.grafana.com/<profile-type>.scrape` <br>or<br> `profiles.grafana.com/<profile-type>.scrape` | Boolean whether or not to scrape. (default is `false`).| | ||
| | `profiles.agent.grafana.com/<profile-type>.path` <br>or<br> `profiles.grafana.com/<profile-type>.path` | The path to the profile type on the target. | | ||
| | `profiles.agent.grafana.com/tenant` <br>or<br> `profiles.grafana.com/tenant` | The `tenant` to write profile to. default: (.*) | | ||
| | `profiles.agent.grafana.com/scheme` <br>or<br> `profiles.grafana.com/scheme` | The default scraping scheme is `http`. | | ||
| | `profiles.agent.grafana.com/port` <br>or<br> `profiles.grafana.com/port` | the default `port` to scrape is the target port, this can be specified as a single value which would override the scrape port being used for all ports attached to the target, note that even if an target had multiple targets, the relabel_config targets are deduped before scraping | | ||
| | `profiles.agent.grafana.com/interval` <br>or<br> `profiles.grafana.com/interval`| The default `interval` to scrape is `30s`, this can be override. | | ||
| | `profiles.agent.grafana.com/timeout` <br>or<br> `profiles.grafana.com/timeout` | The default `timeout` for scraping is `15s`, this can be override. | |
Oops, something went wrong.