Skip to content

Commit

Permalink
Update Getting started topics for style, syntax, layout, spacing (#5909)
Browse files Browse the repository at this point in the history
* Fix spelling mistake

* Fix some text that was removed

* Update variable syntax in setp topics

* Update variable syntax semantic breaks spelling

* Refactoring cleanup spelling syntax

* Refactor Otel topic cleanup spelling syntax

* Refactoring layout spelling syntax spacing

* Fix some bad links

* Correct link syntax

* Cleanup variable references

* Cleanup language and spelling

* Minor corrections spelling and layout

* Fix bad syntax in caution

* Apply suggestions from code review

Co-authored-by: Paulin Todev <paulin.todev@gmail.com>

* Small tweaks from code review

---------

Co-authored-by: Paulin Todev <paulin.todev@gmail.com>
  • Loading branch information
clayton-cornell and ptodev authored Dec 6, 2023
1 parent 4318d50 commit 300ad36
Show file tree
Hide file tree
Showing 15 changed files with 582 additions and 647 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The supported escape sequences are as follows:

## Raw strings

Raw strings are represented by sequences of Unicode characters surrounded by backticks ``` `` ```.
Raw strings are represented by sequences of Unicode characters surrounded by backticks ``` `` ```.
Raw strings do not support any escape sequences:

```river
Expand All @@ -102,7 +102,7 @@ Within the backticks, any character may appear except a backtick. A backtick
can be included by concatenating a double quoted string that contains a
backtick using `+`.

A multiline raw string will be interpretted exactly as written:
A multiline raw string is interpreted exactly as written:

```river
`Hello,
Expand Down
245 changes: 102 additions & 143 deletions docs/sources/flow/getting-started/collect-opentelemetry-data.md

Large diffs are not rendered by default.

333 changes: 139 additions & 194 deletions docs/sources/flow/getting-started/collect-prometheus-metrics.md

Large diffs are not rendered by default.

27 changes: 11 additions & 16 deletions docs/sources/flow/getting-started/configure-agent-clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,26 @@ weight: 400

# Configure {{< param "PRODUCT_NAME" >}} clustering in an existing installation

You can configure {{< param "PRODUCT_NAME" >}} to run with [clustering][] so that
individual {{< param "PRODUCT_ROOT_NAME" >}}s can work together for workload distribution and high
availability.
You can configure {{< param "PRODUCT_NAME" >}} to run with [clustering][] so that individual {{< param "PRODUCT_ROOT_NAME" >}}s can work together for workload distribution and high availability.


> **Note:** Clustering is a [beta][] feature. Beta features are subject to breaking changes and may be
> replaced with equivalent functionality that covers the same use case.
> **Note:** Clustering is a [beta][] feature. Beta features are subject to breaking
> changes and may be replaced with equivalent functionality that covers the same use case.
This topic describes how to add clustering to an existing installation.

## Configure {{< param "PRODUCT_NAME" >}} clustering with Helm Chart

This section guides you through enabling clustering when {{< param "PRODUCT_NAME" >}} is
installed on Kubernetes using the {{< param "PRODUCT_ROOT_NAME" >}} [Helm chart][install-helm].
This section guides you through enabling clustering when {{< param "PRODUCT_NAME" >}} is installed on Kubernetes using the {{< param "PRODUCT_ROOT_NAME" >}} [Helm chart][install-helm].

### Before you begin

- Ensure that your `values.yaml` file has `controller.type` set to
`statefulset`.
- Ensure that your `values.yaml` file has `controller.type` set to `statefulset`.

### Steps

To configure clustering:

1. Amend your existing values.yaml file to add `clustering.enabled=true` inside
of the `agent` block:
1. Amend your existing `values.yaml` file to add `clustering.enabled=true` inside the `agent` block.

```yaml
agent:
Expand All @@ -49,17 +43,18 @@ To configure clustering:
1. Upgrade your installation to use the new `values.yaml` file:

```bash
helm upgrade RELEASE_NAME -f values.yaml
helm upgrade <RELEASE_NAME> -f values.yaml
```

Replace `RELEASE_NAME` with the name of the installation you chose when you
installed the Helm chart.
Replace the following:

- _`<RELEASE_NAME>`_: The name of the installation you chose when you installed the Helm chart.

1. Use the {{< param "PRODUCT_NAME" >}} [UI][] to verify the cluster status:

1. Click **Clustering** in the navigation bar.

2. Ensure that all expected nodes appear in the resulting table.
1. Ensure that all expected nodes appear in the resulting table.

{{% docs/reference %}}
[clustering]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/concepts/clustering.md"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ weight: 500

# Distribute Prometheus metrics scrape load

A good predictor for the size of an {{< param "PRODUCT_NAME" >}} deployment is the number of
Prometheus targets each {{< param "PRODUCT_ROOT_NAME" >}} scrapes. [Clustering][] with target
auto-distribution allows a fleet of {{< param "PRODUCT_ROOT_NAME" >}}s to work together to dynamically
distribute their scrape load, providing high-availability.
A good predictor for the size of an {{< param "PRODUCT_NAME" >}} deployment is the number of Prometheus targets each {{< param "PRODUCT_ROOT_NAME" >}} scrapes.
[Clustering][] with target auto-distribution allows a fleet of {{< param "PRODUCT_ROOT_NAME" >}}s to work together to dynamically distribute their scrape load, providing high-availability.

> **Note:** Clustering is a [beta][] feature. Beta features are subject to breaking
> changes and may be replaced with equivalent functionality that covers the same use case.
Expand All @@ -32,8 +30,7 @@ distribute their scrape load, providing high-availability.

To distribute Prometheus metrics scrape load with clustering:

1. Add the following block to all `prometheus.scrape` components which
should use auto-distribution:
1. Add the following block to all `prometheus.scrape` components, which should use auto-distribution:

```river
clustering {
Expand All @@ -45,8 +42,7 @@ To distribute Prometheus metrics scrape load with clustering:

1. Validate that auto-distribution is functioning:

1. Using the {{< param "PRODUCT_ROOT_NAME" >}} [UI][] on each {{< param "PRODUCT_ROOT_NAME" >}}, navigate to the details page for one of
the `prometheus.scrape` components you modified.
1. Using the {{< param "PRODUCT_ROOT_NAME" >}} [UI][] on each {{< param "PRODUCT_ROOT_NAME" >}}, navigate to the details page for one of the `prometheus.scrape` components you modified.

1. Compare the Debug Info sections between two different {{< param "PRODUCT_ROOT_NAME" >}} to ensure that they're not scraping the same sets of targets.

Expand Down
Loading

0 comments on commit 300ad36

Please sign in to comment.