From 7c2abfbe5584eb0c102365e4fb81df8a69558fe5 Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Fri, 12 Apr 2024 12:48:35 -0700 Subject: [PATCH 1/5] Update cards and move duplicated info to introiduction topic --- docs/sources/_index.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index be064bb4a4..e551813445 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -37,6 +37,12 @@ cards: - title: Reference href: ./reference/ description: Read the reference documentation about the command line tools, configuration blocks, components, and standard library. + - title: Collect OpenTelemetry data + href: ./tasks/collect-opentelemetry-data/ + description: You can configure Alloy to collect OpenTelemetry-compatible data and forward it to any OpenTelemetry-compatible endpoint. Learn how to configure OpenTelemetry data delivery, configure batching, and receive OpenTelemetry data over OTLP. + - title: Collect and forward Prometheus metrics + href: ./tasks/collect-prometheus-metrics/ + description: You can configure Alloy to collect Prometheus metrics and forward them to any Prometheus-compatible database. Learn how to configure metrics delivery and collect metrics from Kubernetes Pods. --- {{< docs/hero-simple key="hero" >}} @@ -59,17 +65,7 @@ You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructu ## What can {{% param "PRODUCT_NAME" %}} do? {{< param "PRODUCT_NAME" >}} is more than just observability signals like metrics, logs, and traces. It provides many features that help you quickly find and process your data in complex environments. -Some of these features include: - -* **Custom components:** You can use {{< param "PRODUCT_NAME" >}} to create and share custom components. - Custom components combine a pipeline of existing components into a single, easy-to-understand component that's just a few lines long. - You can use pre-built custom components from the community, ones packaged by Grafana, or create your own. -* **GitOps compatibility:** {{< param "PRODUCT_NAME" >}} uses frameworks to pull configurations from Git, S3, HTTP endpoints, and just about any other source. -* **Clustering support:** {{< param "PRODUCT_NAME" >}} has native clustering support. - Clustering helps distribute the workload and ensures you have high availability. - You can quickly create horizontally scalable deployments with minimal resource and operational overhead. -* **Security:** {{< param "PRODUCT_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vault servers or Kubernetes clusters to retrieve Kubernetes secrets. -* **Debugging utilities:** {{< param "PRODUCT_NAME" >}} provides debugging tools such as an embedded [user interface][UI] to help you identify and resolve configuration problems. +Some of these features include custom components, GitOps compatibility, clustering support, security, and debugging utilities. Refer to the {{< param "PRODUCT_NAME" >}} [Introduction] for more information on these and other key features. ## Explore @@ -82,4 +78,4 @@ Some of these features include: [Tempo]: https://grafana.com/docs/tempo/ [Mimir]: https://grafana.com/docs/mimir/ [Pyroscope]: https://grafana.com/docs/pyroscope/ -[UI]: ./tasks/debug/#alloy-ui +[Introduction]: ./introduction/ \ No newline at end of file From f091c3074f96b62a73f1ec7d16e42307321df5e1 Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Fri, 12 Apr 2024 13:09:35 -0700 Subject: [PATCH 2/5] Change card order and regen --- docs/sources/_index.md | 12 ++++++------ docs/sources/_index.md.t | 6 ++++++ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index e551813445..5a6e4d5ae6 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -31,18 +31,18 @@ cards: - title: Migrate to Alloy href: ./tasks/migrate/ description: Learn how to migrate to Alloy from Grafana Agent Operator, Prometheus, Promtail, Grafana Agent Static, or Grafana Agent Flow. - - title: Concepts - href: ./concepts/ - description: Learn about components, modules, clustering, and the Alloy configuration syntax. - - title: Reference - href: ./reference/ - description: Read the reference documentation about the command line tools, configuration blocks, components, and standard library. - title: Collect OpenTelemetry data href: ./tasks/collect-opentelemetry-data/ description: You can configure Alloy to collect OpenTelemetry-compatible data and forward it to any OpenTelemetry-compatible endpoint. Learn how to configure OpenTelemetry data delivery, configure batching, and receive OpenTelemetry data over OTLP. - title: Collect and forward Prometheus metrics href: ./tasks/collect-prometheus-metrics/ description: You can configure Alloy to collect Prometheus metrics and forward them to any Prometheus-compatible database. Learn how to configure metrics delivery and collect metrics from Kubernetes Pods. + - title: Concepts + href: ./concepts/ + description: Learn about components, modules, clustering, and the Alloy configuration syntax. + - title: Reference + href: ./reference/ + description: Read the reference documentation about the command line tools, configuration blocks, components, and standard library. --- {{< docs/hero-simple key="hero" >}} diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t index 58a09ae13a..2d6de31d27 100644 --- a/docs/sources/_index.md.t +++ b/docs/sources/_index.md.t @@ -31,6 +31,12 @@ cards: - title: Migrate to Alloy href: ./tasks/migrate/ description: Learn how to migrate to Alloy from Grafana Agent Operator, Prometheus, Promtail, Grafana Agent Static, or Grafana Agent Flow. + - title: Collect OpenTelemetry data + href: ./tasks/collect-opentelemetry-data/ + description: You can configure Alloy to collect OpenTelemetry-compatible data and forward it to any OpenTelemetry-compatible endpoint. Learn how to configure OpenTelemetry data delivery, configure batching, and receive OpenTelemetry data over OTLP. + - title: Collect and forward Prometheus metrics + href: ./tasks/collect-prometheus-metrics/ + description: You can configure Alloy to collect Prometheus metrics and forward them to any Prometheus-compatible database. Learn how to configure metrics delivery and collect metrics from Kubernetes Pods. - title: Concepts href: ./concepts/ description: Learn about components, modules, clustering, and the Alloy configuration syntax. From 199af1816aa299173b71e98d2a5f9a8df5edf22a Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Fri, 12 Apr 2024 13:15:07 -0700 Subject: [PATCH 3/5] Regenerate versioned files --- docs/sources/_index.md | 2 +- docs/sources/_index.md.t | 14 ++------------ 2 files changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 5a6e4d5ae6..7ae6696d1e 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -78,4 +78,4 @@ Some of these features include custom components, GitOps compatibility, clusteri [Tempo]: https://grafana.com/docs/tempo/ [Mimir]: https://grafana.com/docs/mimir/ [Pyroscope]: https://grafana.com/docs/pyroscope/ -[Introduction]: ./introduction/ \ No newline at end of file +[Introduction]: ./introduction/ diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t index 2d6de31d27..8c4dd2ffe0 100644 --- a/docs/sources/_index.md.t +++ b/docs/sources/_index.md.t @@ -65,17 +65,7 @@ You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructu ## What can {{% param "PRODUCT_NAME" %}} do? {{< param "PRODUCT_NAME" >}} is more than just observability signals like metrics, logs, and traces. It provides many features that help you quickly find and process your data in complex environments. -Some of these features include: - -* **Custom components:** You can use {{< param "PRODUCT_NAME" >}} to create and share custom components. - Custom components combine a pipeline of existing components into a single, easy-to-understand component that's just a few lines long. - You can use pre-built custom components from the community, ones packaged by Grafana, or create your own. -* **GitOps compatibility:** {{< param "PRODUCT_NAME" >}} uses frameworks to pull configurations from Git, S3, HTTP endpoints, and just about any other source. -* **Clustering support:** {{< param "PRODUCT_NAME" >}} has native clustering support. - Clustering helps distribute the workload and ensures you have high availability. - You can quickly create horizontally scalable deployments with minimal resource and operational overhead. -* **Security:** {{< param "PRODUCT_NAME" >}} helps you manage authentication credentials and connect to HashiCorp Vault servers or Kubernetes clusters to retrieve Kubernetes secrets. -* **Debugging utilities:** {{< param "PRODUCT_NAME" >}} provides debugging tools such as an embedded [user interface][UI] to help you identify and resolve configuration problems. +Some of these features include custom components, GitOps compatibility, clustering support, security, and debugging utilities. Refer to the {{< param "PRODUCT_NAME" >}} [Introduction] for more information on these and other key features. ## Explore @@ -88,4 +78,4 @@ Some of these features include: [Tempo]: https://grafana.com/docs/tempo/ [Mimir]: https://grafana.com/docs/mimir/ [Pyroscope]: https://grafana.com/docs/pyroscope/ -[UI]: ./tasks/debug/#alloy-ui +[Introduction]: ./introduction/ From 217d8f1f6453d4c57f77940c382dbaaa138ed1d6 Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Mon, 15 Apr 2024 09:17:56 -0700 Subject: [PATCH 4/5] Update reference link destinations --- docs/sources/_index.md | 13 ++++++------- docs/sources/_index.md.t | 7 +++---- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 7ae6696d1e..56e9ed5c04 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -51,9 +51,9 @@ cards: # Overview -{{< param "PRODUCT_NAME" >}} offers native pipelines for OTel, [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools. -In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different tasks, such as configure alert rules in Loki and Mimir. -{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail. +{{< param "PRODUCT_NAME" >}} offers native pipelines for [OTel][], [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools. +In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different tasks, such as configure alert rules in Loki and [Mimir][]. +{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and [Promtail][]. You can use {{< param "PRODUCT_NAME" >}} as an alternative to either of these solutions or combine it into a hybrid system of multiple collectors and agents. You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructure and pair it with your Grafana LGTM stack, a telemetry backend from Grafana Cloud, or any other compatible backend from any other vendor. {{< param "PRODUCT_NAME" >}} is flexible, and you can easily configure it to fit your needs in on-prem, cloud-only, or a mix of both. @@ -71,11 +71,10 @@ Some of these features include custom components, GitOps compatibility, clusteri {{< card-grid key="cards" type="simple" >}} -[OpenTelemetry]: https://opentelemetry.io/ecosystem/distributions/ +[OTel]: https://opentelemetry.io/ecosystem/distributions/ [Prometheus]: https://prometheus.io/ +[Pyroscope]: https://grafana.com/docs/pyroscope/ [Loki]: https://grafana.com/docs/loki/ -[Grafana]: https://grafana.com/docs/grafana/ -[Tempo]: https://grafana.com/docs/tempo/ [Mimir]: https://grafana.com/docs/mimir/ -[Pyroscope]: https://grafana.com/docs/pyroscope/ +[Promtail]: https://grafana.com/docs/loki/latest/send-data/promtail/ [Introduction]: ./introduction/ diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t index 8c4dd2ffe0..324bb9a41f 100644 --- a/docs/sources/_index.md.t +++ b/docs/sources/_index.md.t @@ -71,11 +71,10 @@ Some of these features include custom components, GitOps compatibility, clusteri {{< card-grid key="cards" type="simple" >}} -[OpenTelemetry]: https://opentelemetry.io/ecosystem/distributions/ +[OTel]: https://opentelemetry.io/ecosystem/distributions/ [Prometheus]: https://prometheus.io/ +[Pyroscope]: https://grafana.com/docs/pyroscope/ [Loki]: https://grafana.com/docs/loki/ -[Grafana]: https://grafana.com/docs/grafana/ -[Tempo]: https://grafana.com/docs/tempo/ [Mimir]: https://grafana.com/docs/mimir/ -[Pyroscope]: https://grafana.com/docs/pyroscope/ +[Promtail]: https://grafana.com/docs/loki/latest/send-data/promtail/ [Introduction]: ./introduction/ From 8d479c938afd2f3ed97f6e79679ba56186e0a328 Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Mon, 15 Apr 2024 09:22:51 -0700 Subject: [PATCH 5/5] Updtae template for versioned content --- docs/sources/_index.md.t | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t index 324bb9a41f..53832e8f41 100644 --- a/docs/sources/_index.md.t +++ b/docs/sources/_index.md.t @@ -51,9 +51,9 @@ cards: # Overview -{{< param "PRODUCT_NAME" >}} offers native pipelines for OTel, [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools. -In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different tasks, such as configure alert rules in Loki and Mimir. -{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and Promtail. +{{< param "PRODUCT_NAME" >}} offers native pipelines for [OTel][], [Prometheus][], [Pyroscope][], [Loki][], and many other metrics, logs, traces, and profile tools. +In addition, you can use {{< param "PRODUCT_NAME" >}} pipelines to do different tasks, such as configure alert rules in Loki and [Mimir][]. +{{< param "PRODUCT_NAME" >}} is fully compatible with the OTel Collector, Prometheus Agent, and [Promtail][]. You can use {{< param "PRODUCT_NAME" >}} as an alternative to either of these solutions or combine it into a hybrid system of multiple collectors and agents. You can deploy {{< param "PRODUCT_NAME" >}} anywhere within your IT infrastructure and pair it with your Grafana LGTM stack, a telemetry backend from Grafana Cloud, or any other compatible backend from any other vendor. {{< param "PRODUCT_NAME" >}} is flexible, and you can easily configure it to fit your needs in on-prem, cloud-only, or a mix of both.