Skip to content

Commit

Permalink
Correct link errors, 404s, and incorrect syntax in Agent documentation (
Browse files Browse the repository at this point in the history
#5319)

* Fixing link errors from Hugo build report

* More link corrections

* Fix malformed relrefs

* Fix more broken links and bad anchors

* Fix a few typos and missed elements
  • Loading branch information
clayton-cornell authored Sep 28, 2023
1 parent 4e4ab76 commit 66c4b92
Show file tree
Hide file tree
Showing 58 changed files with 148 additions and 130 deletions.
2 changes: 1 addition & 1 deletion docs/sources/flow/concepts/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ canonical: https://grafana.com/docs/agent/latest/flow/concepts/clustering/
labels:
stage: beta
menuTitle: Clustering
title: Grafana Agent clustering concepts
title: Clustering (beta)
description: Learn about Grafana Agent clustering concepts
weight: 500
---
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/concepts/configuration_language.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ This file has two blocks:
River is documented in detail in [Configuration language][config-docs] section
of the Grafana Agent Flow docs.

[config-docs]: {{< relref "../config-language/" >}}
[config-docs]: {{< relref "../config-language" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Learn about function calls
weight: 400
---

# Function Calls
# Function calls
Function calls is one more River feature that lets users build richer
expressions.

Expand All @@ -31,4 +31,4 @@ env("HOME")
json_decode(local.file.cfg.contents)["namespace"]
```

[standard library]: {{< relref "../../reference/stdlib/_index.md" >}}
[standard library]: {{< relref "../../reference/stdlib" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ the following conventions for referring to types:
descending units can be combined to add their values together; `"1h30m"` is
the same as `"90m"`.

[component reference]: {{< relref "../../reference/components/" >}}
[component reference]: {{< relref "../../reference/components" >}}

## Numbers

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/config-language/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The following example sets the `log_level` attribute to `"debug"`.
log_level = "debug"
```

The `ATTRIBUTE_NAME` must be a valid River [identifier](#identifier).
The `ATTRIBUTE_NAME` must be a valid River [identifier](#identifiers).

The `ATTRIBUTE_VALUE` can be either a constant value of a valid River
[type]({{< relref "./expressions/types_and_values.md" >}}) (eg. string,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Learn how to configure Grafana Agent clustering in an existing inst
weight: 400
---

# Configure Grafana Agent clustering
# Configure Grafana Agent clustering in an existing installation

You can configure Grafana Agent to run with [clustering][] so that
individual agents can work together for workload distribution and high
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/distribute-prometheus-scrape-load/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/distribute-prometheus-scrape-load/
menuTitle: Distribute Prometheus metrics scrape load
title: Distribute your Prometheus metrics scrape load
title: Distribute Prometheus metrics scrape load
description: Learn how to distribute your Prometheus metrics scrape load
weight: 500
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-prometheus/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-prometheus/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-from-prometheus/
description: Learn how to migrate your configuration from Prometheus to Grafana Agent
flow mode
menuTitle: Migrate from Prometheus
title: Migrate from Prometheus to Grafana Agent flow mode
description: Learn how to migrate from Prometheus to Grafana Agent flow mode
title: Migrate from Prometheus to Grafana Agent Flow
description: Learn how to migrate from Prometheus to Grafana Agent Flow
weight: 320
---

# Migrate from Prometheus to Grafana Agent
# Migrate from Prometheus to Grafana Agent Flow

The built-in Grafana Agent convert command can migrate your [Prometheus][] configuration to a Grafana Agent flow configuration.

Expand Down
14 changes: 6 additions & 8 deletions docs/sources/flow/getting-started/migrating-from-promtail.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/getting-started/migrating-from-promtail/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/getting-started/migrating-from-promtail/
canonical: https://grafana.com/docs/agent/latest/flow/getting-started/migrating-from-promtail/
description: Learn how to migrate your configuration from Promtail to Grafana Agent
Flow Mode
menuTitle: Migrate from Promtail
title: Migrate from Promtail to Grafana Agent Flow mode
description: Learn how to migrate from Promtail to Grafana Agent Flow mode
title: Migrate from Promtail to Grafana Agent Flow
description: Learn how to migrate from Promtail to Grafana Agent Flow
weight: 330
---

# Migrate from Promtail to Grafana Agent
# Migrate from Promtail to Grafana Agent Flow

The built-in Grafana Agent convert command can migrate your [Promtail][]
configuration to a Grafana Agent flow configuration.
Expand All @@ -22,7 +20,7 @@ This topic describes how to:
* Convert a Promtail configuration to a Flow Mode configuration.
* Run a Promtail configuration natively using Grafana Agent Flow Mode.

[Promtail]: https://grafana.com/docs/loki/latest/clients/promtail/
[Promtail]: /docs/loki/latest/clients/promtail/

## Components used in this topic

Expand Down Expand Up @@ -207,6 +205,6 @@ Furthermore, we recommend that you review the following checklist:
* Note that the Agent exposes the [Grafana Agent Flow UI][], which differs
from Promtail's Web UI.
[expanded in the config file]: https://grafana.com/docs/loki/latest/clients/promtail/configuration/#use-environment-variables-in-the-configuration
[expanded in the config file]: /docs/loki/latest/clients/promtail/configuration/#use-environment-variables-in-the-configuration
[Grafana Agent Flow UI]: https://grafana.com/docs/agent/latest/flow/monitoring/debugging/#grafana-agent-flow-ui
[Grafana Agent Flow UI]: /docs/agent/latest/flow/monitoring/debugging/#grafana-agent-flow-ui
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ loki.write "grafana_cloud_loki" {
}
```

[Grafana Loki]: https://grafana.com/oss/loki/
[Grafana Loki]: /oss/loki/

## Grafana Tempo

Expand Down
8 changes: 4 additions & 4 deletions docs/sources/flow/monitoring/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ server, which defaults to listening at `http://localhost:12345`.
> learn how to change the HTTP listen address, and pass the appropriate flag
> when running Grafana Agent Flow.
>
> [install]: {{< relref "../setup/install/" >}}
> [install]: {{< relref "../setup/install" >}}
[grafana-agent run]: {{< relref "../reference/cli/run.md" >}}
[grafana-agent run]: {{< relref "../reference/cli/run" >}}

### Home page

Expand Down Expand Up @@ -131,5 +131,5 @@ down and set its state to Terminating, but it has not completely gone away. Chec
the clustering page to view the state of the peers and verify that the
terminating Agent has been shut down.

[logging]: {{< relref "../reference/config-blocks/logging.md" >}}
[clustering]: {{< relref "../concepts/clustering.md" >}}
[logging]: {{< relref "../reference/config-blocks/logging" >}}
[clustering]: {{< relref "../concepts/clustering" >}}
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/cli/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ canonical: https://grafana.com/docs/agent/latest/flow/reference/cli/
description: The Grafana Agent command line interface provides subcommands to perform
various operations.
menuTitle: Command-line interface
title: The Grafana Agent command line interface
title: The Grafana Agent command-line interface
description: Learn about the Grafana Agent command line interface
weight: 100
---

# Command-line interface
# The Grafana Agent command-line interface

When in Flow mode, the `grafana-agent` binary exposes a command-line interface with
subcommands to perform various operations.
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/cli/convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ in [errors].
### Promtail

Using the `--source-format=promtail` will convert the source configuration from
[Promtail v2.8.x](https://grafana.com/docs/loki/v2.8.x/clients/promtail/)
[Promtail v2.8.x](/docs/loki/v2.8.x/clients/promtail/)
to Grafana Agent Flow configuration.

Nearly all [Promtail features](https://grafana.com/docs/loki/v2.8.x/clients/promtail/configuration/)
Nearly all [Promtail features](/docs/loki/v2.8.x/clients/promtail/configuration/)
are supported and can be converted to Grafana Agent Flow config.

If you have unsupported features in a source configuration, you will receive [errors] when you convert to a flow configuration. The converter will
Expand Down
6 changes: 4 additions & 2 deletions docs/sources/flow/reference/components/discovery.http.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ Example response body:
]
```

It is possible to use additional fields in the JSON to pass parameters to [prometheus.scrape](../prometheus.scrape#technical-details) such as the `metricsPath` and `scrape_interval`.
It is possible to use additional fields in the JSON to pass parameters to [prometheus.scrape][] such as the `metricsPath` and `scrape_interval`.

[prometheus.scrape]: {{< relref "./prometheus.scrape.md#technical-details" >}}

As an example, the following will provide a target with a custom `metricsPath`, scrape interval, and timeout value:

Expand Down Expand Up @@ -73,7 +75,7 @@ For example, the following will call a metrics path of `/health?target_data=prom

```

For more information on the potential labels you can use, see the [prometheus.scrape technical details](../prometheus.scrape#technical-details) section, or the [Prometheus Configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config) documentation.
For more information on the potential labels you can use, see the [prometheus.scrape technical details][prometheus.scrape] section, or the [Prometheus Configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config) documentation.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/loki.process.md
Original file line number Diff line number Diff line change
Expand Up @@ -881,7 +881,7 @@ embedded labels are removed from the original log entry:
}
```

At query time, Loki's [`unpack` parser](https://grafana.com/docs/loki/latest/logql/log_queries/#unpack)
At query time, Loki's [`unpack` parser](/docs/loki/latest/logql/log_queries/#unpack)
can be used to access these embedded labels and replace the log line with the
original one stored in the `_entry` field automatically.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/components/loki.source.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The component will start HTTP server on the configured port and address with the
- `/api/v1/raw` - internally reroutes to `/loki/api/v1/raw`


[promtail-push-api]: https://grafana.com/docs/loki/latest/clients/promtail/configuration/#loki_push_api
[promtail-push-api]: /docs/loki/latest/clients/promtail/configuration/#loki_push_api

## Arguments

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ fields take their default values.
| `use_full_line` | `bool` | Send the full line from Cloud Logging even if `textPayload` is available. | `false` | no |

To make use of the `pull` strategy, the GCP project must have been
[configured](https://grafana.com/docs/loki/next/clients/promtail/gcplog-cloud/)
[configured](/docs/loki/next/clients/promtail/gcplog-cloud/)
to forward its cloud resource logs onto a Pub/Sub topic for
`loki.source.gcplog` to consume.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: Learn about otelcol.connector.servicegraph
outputs metrics representing the relationship between various services in a system.
A metric represents an edge in the service graph.
Those metrics can then be used by a data visualization application (e.g.
[Grafana](https://grafana.com/docs/grafana/latest/explore/trace-integration/#service-graph))
[Grafana](/docs/grafana/latest/explore/trace-integration/#service-graph))
to draw the service graph.

> **NOTE**: `otelcol.connector.servicegraph` is a wrapper over the upstream
Expand All @@ -39,7 +39,7 @@ Service graphs are useful for a number of use-cases:
Since `otelcol.connector.servicegraph` has to process both sides of an edge,
it needs to process all spans of a trace to function properly.
If spans of a trace are spread out over multiple Agent instances, spans cannot be paired reliably.
A solution to this problem is using [otelcol.exporter.loadbalancing](../otelcol.exporter.loadbalancing/)
A solution to this problem is using [otelcol.exporter.loadbalancing]({{< relref "./otelcol.exporter.loadbalancing.md" >}})
in front of Agent instances running `otelcol.connector.servicegraph`.

## Usage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ This allows you to automatically build a mechanism for trace discovery.

> **NOTE**: `otelcol.connector.spanlogs` is a custom component unrelated
> to any components from the OpenTelemetry Collector. It is based on the
> `automatic_logging` component in the
> [traces](../../../../static/configuration/traces-config/)
> subsystem of the Agent static mode.
> `automatic_logging` component in the [traces]({{< relref "../../../static/configuration/traces-config" >}}) subsystem of the Agent static mode.
You can specify multiple `otelcol.connector.spanlogs` components by giving them
different labels.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,8 @@ The `exclude` block provides an option to exclude data from being fed into the [

{{% admonition type="note" %}}
Signals excluded by the `exclude` block will still be propagated to downstream components as-is.
If you would like to not propagate certain signals to downstream components,
consider a processor such as [otelcol.processor.tail_sampling](../otelcol.processor.tail_sampling/).
If you would like to not propagate certain signals to downstream components,
consider a processor such as [otelcol.processor.tail_sampling]({{< relref "./otelcol.processor.tail_sampling.md" >}}).
{{% /admonition %}}

{{< docs/shared lookup="flow/reference/components/match-properties-block.md" source="agent" version="<AGENT VERSION>" >}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
canonical: https://grafana.com/docs/agent/latest/flow/reference/components/prometheus.exporter.agent/
title: prometheus.exporter.agen
title: prometheus.exporter.agent
description: Learn about prometheus.exporter.agen
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: Learn about prometheus.operator.probes

{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT VERSION>" >}}

`prometheus.operator.probes` discovers [Probe](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.Probe) resources in your kubernetes cluster and scrapes the targets they reference. This component performs three main functions:
`prometheus.operator.probes` discovers [Probe](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.Probe) resources in your Kubernetes cluster and scrapes the targets they reference. This component performs three main functions:

1. Discover Probe resources from your Kubernetes cluster.
2. Discover targets or ingresses that match those Probes.
Expand Down Expand Up @@ -184,7 +184,7 @@ fully consistent like hashmod sharding is).
If the agent is _not_ running in clustered mode, then the block is a no-op, and
`prometheus.operator.probes` scrapes every target it receives in its arguments.

[clustered mode]: {{< relref "../cli/run.md#clustered-mode-experimental" >}}
[clustered mode]: {{< relref "../cli/run.md#clustering-beta" >}}

## Exported fields

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/reference/components/pyroscope.write.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ description: Learn about pyroscope.write
{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT VERSION>" >}}

`pyroscope.write` receives performance profiles from other components and forwards them
to a series of user-supplied endpoints using [Pyroscope' Push API](https://grafana.com/oss/pyroscope/).
to a series of user-supplied endpoints using [Pyroscope' Push API](/oss/pyroscope/).

Multiple `pyroscope.write` components can be specified by giving them
different labels.

## Usage
## Usage for Grafana Agent flow mode

```river
pyroscope.write "LABEL" {
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/config-blocks/argument.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/config-blocks/argument/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/config-blocks/argument/
canonical: https://grafana.com/docs/agent/latest/flow/reference/config-blocks/argument/
title: argument
title: argument block
menuTitle: argument
description: Learn about the argument configuration block
---

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/config-blocks/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/config-blocks/export/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/config-blocks/export/
canonical: https://grafana.com/docs/agent/latest/flow/reference/config-blocks/export/
title: export
title: export block
menuTitle: export
description: Learn about the export configuration block
---

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/config-blocks/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/config-blocks/http/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/config-blocks/http/
canonical: https://grafana.com/docs/agent/latest/flow/reference/config-blocks/http/
title: http
title: http block
menuTitle: http
description: Learn about the http configuration block
---

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/config-blocks/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/config-blocks/logging/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/config-blocks/logging/
canonical: https://grafana.com/docs/agent/latest/flow/reference/config-blocks/logging/
title: logging
title: logging block
menuTitle: logging
description: Learn about the logging configuration block
---

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/flow/reference/config-blocks/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ aliases:
- /docs/grafana-cloud/monitor-infrastructure/agent/flow/reference/config-blocks/tracing/
- /docs/grafana-cloud/monitor-infrastructure/integrations/agent/flow/reference/config-blocks/tracing/
canonical: https://grafana.com/docs/agent/latest/flow/reference/config-blocks/tracing/
title: tracing
title: tracing block
menuTitle: tracing
description: Learn about the tracing configuration block
---

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/stdlib/to_lower.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: to_lower
description: Learn about to_lower
---

# lower
# to_lower

`to_lower` converts all uppercase letters in a string to lowercase.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/reference/stdlib/to_upper.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: to_upper
description: Learn about to_upper
---

# upper
# to_upper

`to_upper` converts all lowercase letters in a string to uppercase.

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/flow/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ aliases:
canonical: https://grafana.com/docs/agent/latest/flow/release-notes/
description: Release notes for Grafana Agent flow mode
menuTitle: Release notes
title: Release notes for Grafana Agentflow mode
title: Release notes for Grafana Agent flow mode
weight: 999
---

# Release notes
# Release notes for Grafana Agent flow mode

The release notes provide information about deprecations and breaking changes in Grafana Agent flow mode.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/flow/setup/configure/configure-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ the [UI for debugging][UI].

To expose the UI to other machines, complete the following steps:

1. Follow [Configure the Grafana Agent service](#configure-the-grafana-agent-flow-service)
1. Follow [Configure the Grafana Agent service](#configure-the-grafana-agent-service)
to edit command line flags passed to Grafana Agent, including the
following customizations:

Expand Down
Loading

0 comments on commit 66c4b92

Please sign in to comment.