first draft of alloy overview rewrite #2031
Conversation
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
Co-authored-by: Clayton Cornell <[email protected]>
| * GitOps compatibility | ||
| * Clustering support | ||
| * Security | ||
| * Debugging utilities | ||
|
|
||
| {{< 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. | ||
|
|
There was a problem hiding this comment.
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?
| * GitOps compatibility | ||
| * Clustering support | ||
| * Security | ||
| * Debugging utilities | ||
|
|
||
| {{< 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. | ||
|
|
There was a problem hiding this comment.
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?
| @@ -54,30 +58,18 @@ hero: | |||
|
|
|||
| 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 a multifunction tool you can use to collect, process, and forward telemetry data to the observability backend of your choosing. | |||
| {{< 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. | |||
There was a problem hiding this comment.
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.
PR Description
Editing overview page of Alloy
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist