Add a table to the flow description showing benefits and strengths of flow #5732
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clayton-cornell
changed the title
clayton-cornell
added
type/docs
jdbaldry
reviewed
Nov 9, 2023
rfratto
reviewed
Nov 10, 2023
docs/sources/about.md
Outdated
Comment on lines
103
to
121
| #### Core telemetry | ||
|
|
||
| | | Prometheus Agent mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Grafana Agent Flow mode | | ||
| |--------------|-----------------------|---------------------------|------------------------|-------------------------|--------------------------| | ||
| | **Metrics** | Prometheus | Prometheus | Prometheus | OTel | [Prometheus][], [OTel][] | | ||
| | **Logs** | No | Loki | Loki | OTel | [Loki][], [OTel][] | | ||
| | **Traces** | No | OTel | OTel | OTel | [OTel][] | | ||
| | **Profiles** | No | No | No | No | Pyroscope | | ||
|
|
||
| * **Full OpenTelemetry support**: Support for collecting OpenTelemetry | ||
| metrics, logs, and traces. | ||
| #### **OSS features** | ||
|
|
||
| * **PrometheusRule support**: Support for the PrometheusRule resource from | ||
| the Prometheus Operator project for configuring Grafana Mimir. | ||
| | | Prometheus Agent mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Grafana Agent Flow mode | | ||
| |--------------------------|-----------------------|---------------------------|------------------------|-------------------------|-------------------------| | ||
| | **Kubernetes native** | No | No | Yes | Yes | Yes | | ||
| | **Clustering** | No | No | No | No | No | | ||
| | **Prometheus rules** | No | No | No | No | Yes | | ||
| | **Native Vault support** | No | No | No | No | Yes | | ||
|
|
||
| * **Ecosystem transformation**: You need to be able to convert Prometheus and | ||
| Loki pipelines to and from OpenTelmetry Collector pipelines. | ||
| #### Grafana Cloud solutions |
There was a problem hiding this comment.
It feels strange to me for these to be subheaders of Flow mode, since it also describes the features of all other nodes. Should there be a dedicated h2 section for these?
There was a problem hiding this comment.
I moved the tables up to the top of the document and added a simple lead-in
thampiotr
reviewed
Nov 14, 2023
docs/sources/about.md
Outdated
Comment on lines
105
to
110
| | | Prometheus Agent mode | Grafana Agent Static mode | Grafana Agent Operator | OpenTelemetry Collector | Grafana Agent Flow mode | | ||
| |--------------|-----------------------|---------------------------|------------------------|-------------------------|--------------------------| | ||
| | **Metrics** | Prometheus | Prometheus | Prometheus | OTel | [Prometheus][], [OTel][] | | ||
| | **Logs** | No | Loki | Loki | OTel | [Loki][], [OTel][] | | ||
| | **Traces** | No | OTel | OTel | OTel | [OTel][] | | ||
| | **Profiles** | No | No | No | No | Pyroscope | |
There was a problem hiding this comment.
Should we make Flow the first column in these tables? It seems to me more eye traffic will be on the left and also in case of narrow browser windows.
There was a problem hiding this comment.
@thampiotr I switched the order of the columns going with Flow, Static, Operator, OTel, Prometheus.
thampiotr
approved these changes
Nov 16, 2023
grafanabot
pushed a commit
that referenced
this pull request
Nov 16, 2023
… flow (#5732) * First draft adding config table * Rephrase soem parts and move tables * Update docs/sources/about.md Co-authored-by: Jack Baldry <[email protected]> * Cleanup some semantic linebreaks * Reorg tabels, add note to operator * Fix broken link --------- Co-authored-by: Jack Baldry <[email protected]> (cherry picked from commit 7e33d9c)
clayton-cornell
added a commit
that referenced
this pull request
Nov 16, 2023
… flow (#5732) (#5792) * First draft adding config table * Rephrase soem parts and move tables * Update docs/sources/about.md Co-authored-by: Jack Baldry <[email protected]> * Cleanup some semantic linebreaks * Reorg tabels, add note to operator * Fix broken link --------- Co-authored-by: Jack Baldry <[email protected]> (cherry picked from commit 7e33d9c) Co-authored-by: Clayton Cornell <[email protected]>
github-actions
bot
added
the
frozen-due-to-age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR Description
This PR adds 3 tables to the Static/Flow decision topic. This is groundwork information for future flow topic refinement.
Some minor tidy and cleanup is included in this PR. This stats the alignment between the various entry topics. Longer term plan here is to reduce duplication and simplify the message (future PRs to focus on the cleanup and merging of information).
Which issue(s) this PR fixes
Notes to the Reviewer
PR Checklist