first draft of alloy overview rewrite #2031
Conversation
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
| {{< 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. |
There was a problem hiding this comment.
| Getting the relevant telemetry data (i.e. metrics, logs, and traces) for analysis is an indispensable part of understanding the health of your system. | |
| Collecting the relevant metrics, logs, and traces for analysis is an indispensable part of understanding the health of your system. |
We shouldn't use i.e. in the docs.
Do we need to use telemetry data here? Is there other telemetry data collected other than metrics, logs and traces?
I feel like we are missing some of the details for things that Alloy can do beyond collecting metrics, logs and traces. The original text mentions things like alerts, hybrid configurations, being deployed anywhere in the LGTM stack, Grafana Cloud, or other compatible backends/vendors.
| 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. | ||
|
|
||
| Think of {{< param "PRODUCT_NAME" >}} as a Swiss army knife for collecting, processing, and forwarding telemetry data to the data source of your choosing. |
There was a problem hiding this comment.
| Think of {{< param "PRODUCT_NAME" >}} as a Swiss army knife for collecting, processing, and forwarding telemetry data to the data source of your choosing. | |
| {{< param "PRODUCT_NAME" >}} is a multifunction tool you can use to collect, process, and forward telemetry data to the data receiver of your choosing. |
Where do we forward data? I don't think it's a data source. It's some kind of receiver., right? Either external or to the next step in the pipeline (eg the output of one component can be input for the next component),
| Getting started with Alloy consists of 3 major steps: | ||
| 1. Install {{< param "PRODUCT_NAME" >}} | ||
| 1. Configure {{< param "PRODUCT_NAME" >}} | ||
| 1. Collect and forward telemetry data to the data source of choice |
There was a problem hiding this comment.
| 1. Collect and forward telemetry data to the data source of choice | |
| 1. Collect and forward telemetry data to the data receiver of choice |
I'm not sure receiver is the best word here...
| 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. | ||
| * [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/) |
There was a problem hiding this comment.
There are more tutorials available... do we want to include them?
There was a problem hiding this comment.
Hey @clayton-cornell ! I intentionally put those two tutorials there as these go over the steps mentioned above from start to finish.
What do you think about adding a third bullet point and linking the tutorial page?
- For more tutorials, check out the tutorial page (or something like that?)
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
PR Description
Editing overview page of Alloy
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist