Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

first draft of alloy overview rewrite #2031

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
+54 −54
Open

first draft of alloy overview rewrite #2031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c3ad4bd
first draft of alloy overview rewrite
LisaHJung Nov 4, 2024
58a27d8
update Alloy and Otel versions
LisaHJung Nov 4, 2024
d566ee3
Apply suggestions from code review
LisaHJung Nov 4, 2024
1177caf
Apply suggestions from code review
LisaHJung Nov 4, 2024
276cabc
edited the template doc
LisaHJung Nov 4, 2024
515e175
Regenerate indext file
clayton-cornell Nov 4, 2024
3e7ce45
Update docs/sources/_index.md
LisaHJung Nov 5, 2024
7de5261
Update docs/sources/_index.md
LisaHJung Nov 5, 2024
6f49c90
Update docs/sources/_index.md
LisaHJung Nov 5, 2024
c149d4f
Update docs/sources/_index.md
LisaHJung Nov 5, 2024
122640e
Update docs/sources/_index.md
LisaHJung Nov 5, 2024
48a39ab
updated the overview page incorporating Clayton's feedback
LisaHJung Nov 14, 2024
a9c7fb6
Generate versioned topic
clayton-cornell Nov 14, 2024
ecce18a
General rework to align styles and content flow
clayton-cornell Nov 14, 2024
a34581e
corrected misspelling and abbreviation that was mistakenly left
LisaHJung Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions docs/sources/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,34 @@ hero:
width: 110
height: 110
description: >-
Grafana Alloy is a vendor-neutral distribution of the OpenTelemetry (OTel) Collector. Alloy uniquely combines the very best OSS observability signals in the community.
cards:
Grafana Alloy is a vendor-neutral distribution of the OpenTelemetry (OTel) Collector. With Alloy, you can instrument your application or infrastructure to collect, process, and forward telemetry data to the observability backend of your choice.
cards:
title_class: pt-0 lh-1
items:
- title: Introduction
href: ./introduction/
description: Discover more about the key features and benefits of Alloy.
- title: Concepts
href: ./get-started/
description: Learn about components, modules, clustering, and the Alloy configuration syntax.
- title: Install Alloy
href: ./set-up/install/
description: Learn how to install and uninstall Alloy on Docker, Kubernetes, Linux, macOS, or Windows.
- title: Run Alloy
href: ./set-up/run/
description: Learn how to start, restart, and stop Alloy after you have installed it.
- title: Configure Alloy
href: ./configure/
description: Learn how to configure Alloy on Kubernetes, Linux, macOS, or Windows.
- title: Run Alloy
href: ./set-up/run/
description: Learn how to start, restart, and stop Alloy after you have installed it.
- title: Migrate to Alloy
href: ./set-up/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: ./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: ./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: ./get-started/
description: Learn about components, modules, clustering, and the Alloy configuration syntax.
- title: Use Alloy to send logs to Loki
href: ./tutorials/send-logs-to-loki/
description: Learn how to use Grafana Alloy to send logs to Loki.
- title: Use Alloy to send metrics to Prometheus
href: ./tutorials/send-metrics-to-prometheus/
description: Learn how to use Grafana Alloy to send metrics to Prometheus.
- title: Reference
href: ./reference/
description: Read the reference documentation about the command line tools, configuration blocks, components, and standard library.
Expand All @@ -53,21 +56,19 @@ 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][].
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.
Collecting the relevant telemetry data, such as metrics, logs, and traces, for analysis is an indispensable part of understanding the health of your system.

{{< param "PRODUCT_NAME" >}} is more than just a collector. You can use {{< param "PRODUCT_NAME" >}} to collect, process, and forward telemetry data to the observability backend of your choosing.

{{< admonition type="tip" >}}
{{< param "PRODUCT_NAME" >}} uses the same components, code, and concepts that were first introduced in Grafana Agent Flow.
{{< /admonition >}}
{{< param "PRODUCT_NAME" >}} has the following features to help you customize, scale, secure, and troubleshoot your data pipeline.

## What can {{% param "PRODUCT_NAME" %}} do?
* Custom components
* GitOps compatibility
* Clustering support
* Security
* Debugging utilities

{{< 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, GitOps compatibility, clustering support, security, and debugging utilities. Refer to the {{< param "PRODUCT_NAME" >}} [Introduction] for more information on these and other key features.
{{< 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing to add here is a clear call to action, which is for them to install, configure, and collect forward telemetry data.

We could do that by including the section on getting started in the original draft on the overview page

OR

include a blurb saying, "Getting started with Alloy consists of 3 major steps.
Click here to get started." Then, link it to a new page with content in the original draft as shown below.

New page:
Getting started with Alloy consists of 3 major steps:

  1. Install {{< param "PRODUCT_NAME" >}}
  2. Configure {{< param "PRODUCT_NAME" >}}
  3. Collect and forward telemetry data to the observability backend of your choice.

In addition, you can use the Grafana dashboard to visualize the data collected from the app or infrastructure.

For a quick overview of this process, check out the following tutorials.

What do you think?

## Explore

Expand All @@ -79,4 +80,3 @@ Some of these features include custom components, GitOps compatibility, clusteri
[Loki]: https://grafana.com/docs/loki/
[Mimir]: https://grafana.com/docs/mimir/
[Promtail]: https://grafana.com/docs/loki/latest/send-data/promtail/
[Introduction]: ./introduction/
54 changes: 27 additions & 27 deletions docs/sources/_index.md.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,34 @@ hero:
width: 110
height: 110
description: >-
Grafana Alloy is a vendor-neutral distribution of the OpenTelemetry (OTel) Collector. Alloy uniquely combines the very best OSS observability signals in the community.
cards:
Grafana Alloy is a vendor-neutral distribution of the OpenTelemetry (OTel) Collector. With Alloy, you can instrument your app or infrastrastructure to collect, process, and forward telemetry data to the observability backend of your choice.
cards:
title_class: pt-0 lh-1
items:
- title: Introduction
href: ./introduction/
description: Discover more about the key features and benefits of Alloy.
- title: Concepts
href: ./get-started/
description: Learn about components, modules, clustering, and the Alloy configuration syntax.
- title: Install Alloy
href: ./set-up/install/
description: Learn how to install and uninstall Alloy on Docker, Kubernetes, Linux, macOS, or Windows.
- title: Run Alloy
href: ./set-up/run/
description: Learn how to start, restart, and stop Alloy after you have installed it.
- title: Configure Alloy
href: ./configure/
description: Learn how to configure Alloy on Kubernetes, Linux, macOS, or Windows.
- title: Run Alloy
href: ./set-up/run/
description: Learn how to start, restart, and stop Alloy after you have installed it.
- title: Migrate to Alloy
href: ./set-up/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: ./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: ./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: ./get-started/
description: Learn about components, modules, clustering, and the Alloy configuration syntax.
- title: Use Alloy to send logs to Loki
href: ./tutorials/send-logs-to-loki/
description: Learn how to use Grafana Alloy to send logs to Loki.
- title: Use Alloy to send metrics to Prometheus
href: ./tutorials/send-metrics-to-prometheus/
description: Learn how to use Grafana Alloy to send metrics to Prometheus.
- title: Reference
href: ./reference/
description: Read the reference documentation about the command line tools, configuration blocks, components, and standard library.
Expand All @@ -53,21 +56,19 @@ 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][].
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.
Collecting the relevant telemetry data, such as metrics, logs, and traces, for analysis is an indispensable part of understanding the health of your system.

{{< param "PRODUCT_NAME" >}} is more than just a collector. You can use {{< param "PRODUCT_NAME" >}} to collect, process, and forward telemetry data to the observability backend of your choosing.
Copy link
Contributor Author

@LisaHJung LisaHJung Nov 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we change this sentence to:

Alloy is software that collects, processes, and forwards telemetry data to an observability backend of your choice, where they can be stored & visualized.


{{< admonition type="tip" >}}
{{< param "PRODUCT_NAME" >}} uses the same components, code, and concepts that were first introduced in Grafana Agent Flow.
{{< /admonition >}}
{{< param "PRODUCT_NAME" >}} has the following features to help you customize, scale, secure, and troubleshoot your data pipeline.

## What can {{% param "PRODUCT_NAME" %}} do?
* Custom components
* GitOps compatibility
* Clustering support
* Security
* Debugging utilities

{{< 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, GitOps compatibility, clustering support, security, and debugging utilities. Refer to the {{< param "PRODUCT_NAME" >}} [Introduction] for more information on these and other key features.
{{< 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing to add here is a clear call to action, which is for them to install, configure, and collect forward telemetry data.

We could do that by including the section on getting started in the original draft on the overview page

OR

include a blurb saying, "Getting started with Alloy consists of 3 major steps.
Click here to get started." Then, link it to a new page with content in the original draft as shown below.

New page:
Getting started with Alloy consists of 3 major steps:

Install {{< param "PRODUCT_NAME" >}}
Configure {{< param "PRODUCT_NAME" >}}
Collect and forward telemetry data to the observability backend of your choice.
In addition, you can use the Grafana dashboard to visualize the data collected from the app or infrastructure.

For a quick overview of this process, check out the following tutorials.

Use Grafana Alloy to send logs to Loki
Use Grafana Alloy to send metrics to Prometheus
For more tutorials, check out the tutorial page
What do you think?

## Explore

Expand All @@ -79,4 +80,3 @@ Some of these features include custom components, GitOps compatibility, clusteri
[Loki]: https://grafana.com/docs/loki/
[Mimir]: https://grafana.com/docs/mimir/
[Promtail]: https://grafana.com/docs/loki/latest/send-data/promtail/
[Introduction]: ./introduction/
Loading