Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
base: main
Are you sure you want to change the base?
first draft of alloy overview rewrite #2031
Changes from 14 commits
c3ad4bd58a27d8d566ee31177caf276cabc515e1753e7ce457de52616f49c90c149d4f122640e48a39aba9c7fb6ecce18aa34581e62522e28e2ef891bec9f0bdfc6f4File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Collecting,, processing, and forwarding is what any collector does :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The initial sentence was an attempt to rework some other suggested wording that didn't quite fit. I agree, it's better to simply drop it altogether.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ptodev and @clayton-cornell
What do you think about changing this sentence to:
Alloy is a software that collects, processes, and forwards telemetry data to an observability backend of your choice, where they can be stored & visualized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless those bullet points are links, this might be too abstract and people may not understand it. We could either make them links, or explain it in more simple terms. Probably links are the better option.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ptodev , agreed.
I was trying to simplify what was on the original page but perhaps it's better to leave it out completely and explain this on another page. What do you think?
There was a problem hiding this comment.
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:
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some thoughts on this:
Click herein any documentation.3 major stepspart doesn't fit in so well... if we want to dive into this level of detail, then it should be on a child page.There was a problem hiding this comment.
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/
There was a problem hiding this comment.
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 a software that collects, processes, and forwards telemetry data to an observability backend of your choice, where they can be stored & visualized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or:
Alloy collects, processes, and forwards telemetry data to an observability backend where is stored and visualized.There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's normally clear to users that they have to install and configure it. The main issue is that there are many ways to do so. For example, do they have to deploy one Alloy per server? Or one central Alloy instance? What if they use OpenTelemetry? Or Prometheus? I think we should simply link to several articles which help them get started quickly with the sort of telemetry they are interested in. The ones you linked to are a good choice:
Use Grafana Alloy to send logs to Loki
Use Grafana Alloy to send metrics to PrometheusUse Grafana Alloy to send logs to Loki
Use Grafana Alloy to send metrics to Prometheus
I'd also add one more about collecting OpenTelemetry. I do also wonder if we should rename those pages like this
This reflects the current guidance on how to use components.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ptodev, this is such a great point.
@clayton-cornell recommended that we do not add a CTA to an overview page, which makes sense.
I suggest we include this information on the get started page: https://grafana.com/docs/alloy/latest/get-started/
Why don't we touch base on this when we restructure and improve the getting started page of the doc?