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.

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

first draft of alloy overview rewrite #2031

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open
Changes from 2 commits
Commits
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
48 changes: 29 additions & 19 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,30 +17,30 @@ 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.
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 data source of your choice.
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
cards:
title_class: pt-0 lh-1
items:
- title: Install Alloy
href: ./set-up/install/
href: ./get-started/install/
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
description: Learn how to install and uninstall Alloy on Docker, Kubernetes, Linux, macOS, or Windows.
- title: Run Alloy
href: ./set-up/run/
href: ./get-started/run/
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
description: Learn how to start, restart, and stop Alloy after you have installed it.
- title: Configure Alloy
href: ./configure/
href: ./tasks/configure/
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
description: Learn how to configure Alloy on Kubernetes, Linux, macOS, or Windows.
- title: Migrate to Alloy
href: ./set-up/migrate/
href: ./tasks/migrate/
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
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/
href: ./tasks/collect-opentelemetry-data/
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
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/
href: ./tasks/collect-prometheus-metrics/
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
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/
href: ./concepts/
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
description: Learn about components, modules, clustering, and the Alloy configuration syntax.
- title: Reference
href: ./reference/
Expand All @@ -53,21 +53,31 @@ 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.
Getting the relevant telemetry data (i.e. metrics, logs, and traces) for analysis is an indispensable part of understanding the health of your system.
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved

Think of {{< param "PRODUCT_NAME" >}} as a Swiss army knife for collecting, processing, and forwarding telemetry data to the data source of your choosing.
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved

{{< param "PRODUCT_NAME" >}} has the following features to help you customize, scale, secure, and troubleshoot your data pipeline.
1. Custom components
1. GitOps compatibility
1. Clustering support
1. Security
1. Debugging utilities

Check out the {{< param "PRODUCT_NAME" >}} [Introduction] page for more information on these and other key features.
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved

{{< 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.
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved

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?

Copy link
Contributor

@clayton-cornell clayton-cornell Dec 3, 2024

Choose a reason for hiding this comment

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

Some thoughts on this:

  • I'd really like to keep this landing page as simple as possible... and in-line with the other Grafana product landing pages.
  • We should never use Click here in any documentation.
  • The 3 major steps part doesn't fit in so well... if we want to dive into this level of detail, then it should be on a child page.
  • The landing page should simply introduce the product, not provide steps/instructions.

Copy link
Contributor Author

@LisaHJung LisaHJung Dec 5, 2024

Choose a reason for hiding this comment

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

Agreed. @clayton-cornell Why don't we leave out the call to action part and include the suggested text on the Get Started page?
https://grafana.com/docs/alloy/latest/get-started/

{{< admonition type="tip" >}}
{{< param "PRODUCT_NAME" >}} uses the same components, code, and concepts that were first introduced in Grafana Agent Flow.
{{< /admonition >}}
Getting started with Alloy consists of 3 major steps:
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
1. Install {{< param "PRODUCT_NAME" >}}
1. Configure {{< param "PRODUCT_NAME" >}}
1. Collect and forward telemetry data to the data source of choice
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved

## What can {{% param "PRODUCT_NAME" %}} do?
In addition, you can use Grafana dashboard to visualize the data collected from app or infrastructure.
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved

{{< 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.
For a quick overview of this process, check out the following tutorials.
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved
* [Use Grafana Alloy to send logs to Loki](https://grafana.com/docs/alloy/latest/tutorials/send-logs-to-loki/)
* [Use Grafana Alloy to send metrics to Prometheus](https://grafana.com/docs/alloy/latest/tutorials/send-metrics-to-prometheus/)
LisaHJung marked this conversation as resolved.
Show resolved Hide resolved

## Explore

Expand Down
Loading