From 0edf6dedeff2a8904c0a91c8843418fbca00ed8b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 15 Apr 2024 12:52:47 -0400 Subject: [PATCH] Update cards on main Alloy docs landing page (#568) (#583) * Update cards and move duplicated info to introiduction topic * Change card order and regen * Regenerate versioned files * Update reference link destinations * Updtae template for versioned content (cherry picked from commit ab255303a0565b8fa4a7d9be5be74be0b01eb144) Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> --- docs/sources/_index.md | 33 ++++++++++++++------------------- docs/sources/_index.md.t | 33 ++++++++++++++------------------- 2 files changed, 28 insertions(+), 38 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 26c24e0809..9b505c1147 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -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. @@ -45,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. @@ -59,27 +65,16 @@ 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 {{< 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/ -[UI]: ./tasks/debug/#alloy-ui +[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 58a09ae13a..53832e8f41 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. @@ -45,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. @@ -59,27 +65,16 @@ 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 {{< 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/ -[UI]: ./tasks/debug/#alloy-ui +[Promtail]: https://grafana.com/docs/loki/latest/send-data/promtail/ +[Introduction]: ./introduction/