From d5fdb2225fc5593ac85e45ee63daa0cb20db154b Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Tue, 26 Mar 2024 16:31:11 -0700 Subject: [PATCH] Update more instances of River --- docs/sources/about.md | 2 +- .../expressions/types_and_values.md | 6 ++--- docs/sources/get-started/install/windows.md | 4 ++-- docs/sources/get-started/run/windows.md | 4 ++-- docs/sources/reference/cli/run.md | 2 +- .../reference/components/loki.process.md | 4 ++-- .../otelcol.connector.spanmetrics.md | 4 ++-- .../otelcol.processor.attributes.md | 2 +- .../components/otelcol.processor.filter.md | 12 +++++----- .../otelcol.processor.resourcedetection.md | 10 ++++----- .../components/otelcol.processor.transform.md | 22 +++++++++---------- .../components/prometheus.exporter.gcp.md | 2 +- .../reference/config-blocks/import.git.md | 4 ++-- docs/sources/reference/stdlib/json_decode.md | 4 ++-- docs/sources/reference/stdlib/json_path.md | 2 +- docs/sources/tasks/configure/_index.md | 2 +- .../tasks/configure/configure-macos.md | 2 +- docs/sources/tasks/migrate/from-operator.md | 4 ++-- docs/sources/tasks/migrate/from-prometheus.md | 4 ++-- docs/sources/tasks/migrate/from-promtail.md | 4 ++-- docs/sources/tasks/migrate/from-static.md | 4 ++-- .../first-components-and-stdlib/index.md | 15 +++++++------ .../tutorials/flow-by-example/get-started.md | 6 ++--- 23 files changed, 63 insertions(+), 62 deletions(-) diff --git a/docs/sources/about.md b/docs/sources/about.md index 9161959406..6cc3501594 100644 --- a/docs/sources/about.md +++ b/docs/sources/about.md @@ -68,7 +68,7 @@ prometheus.remote_write "default" { The {{< param "PRODUCT_NAME" >}} [configuration generator][] helps you get a head start on creating {{< param "PRODUCT_NAME" >}} configurations. {{< admonition type="note" >}} -This feature is experimental, and it doesn't support all River components. +This feature is experimental, and it doesn't support all {{< param "PRODUCT_NAME" >}} components. {{< /admonition >}} ## Next steps diff --git a/docs/sources/concepts/config-language/expressions/types_and_values.md b/docs/sources/concepts/config-language/expressions/types_and_values.md index 88c5046084..7ad987f300 100644 --- a/docs/sources/concepts/config-language/expressions/types_and_values.md +++ b/docs/sources/concepts/config-language/expressions/types_and_values.md @@ -1,13 +1,13 @@ --- canonical: https://grafana.com/docs/alloy/latest/concepts/config-language/expressions/types_and_values/ -description: Learn about the River types and values +description: Learn about the {{< param "PRODUCT_NAME" >}} syntax types and values title: Types and values weight: 100 --- # Types and values -River uses the following types for its values: +The {{< param "PRODUCT_NAME" >}} syntax uses the following types for its values: * `number`: Any numeric value, like `3` or `3.14`. * `string`: A sequence of Unicode characters representing text, like `"Hello, world!"`. @@ -42,7 +42,7 @@ In addition to the preceding types, the [component reference][] documentation us ## Numbers -River handles integers, unsigned integers, and floating-point values as a single 'number' type, simplifying writing and reading River configuration files. +The {{< param "PRODUCT_NAME" >}} syntax handles integers, unsigned integers, and floating-point values as a single 'number' type, simplifying writing and reading {{< param "PRODUCT_NAME" >}} configuration files. ```river 3 == 3.00 // true diff --git a/docs/sources/get-started/install/windows.md b/docs/sources/get-started/install/windows.md index e3f1d93f95..f6ae85f625 100644 --- a/docs/sources/get-started/install/windows.md +++ b/docs/sources/get-started/install/windows.md @@ -24,7 +24,7 @@ To do a standard graphical install of {{< param "PRODUCT_NAME" >}} on Windows, p 1. Double-click on `alloy-installer.exe` to install {{< param "PRODUCT_NAME" >}}. -{{< param "PRODUCT_NAME" >}} is installed into the default directory `C:\Program Files\Grafana Alloy`. +{{< param "PRODUCT_NAME" >}} is installed into the default directory `C:\Program Files\Grafana\Alloy`. ## Silent install @@ -64,7 +64,7 @@ To do a silent install of {{< param "PRODUCT_NAME" >}} on Windows, perform the f ## Uninstall -You can uninstall {{< param "PRODUCT_NAME" >}} with Windows Remove Programs or `C:\Program Files\Grafana Alloy\uninstaller.exe`. +You can uninstall {{< param "PRODUCT_NAME" >}} with Windows Remove Programs or `C:\Program Files\Grafana\Alloy\uninstaller.exe`. Uninstalling {{< param "PRODUCT_NAME" >}} stops the service and removes it from disk. This includes any configuration files in the installation directory. diff --git a/docs/sources/get-started/run/windows.md b/docs/sources/get-started/run/windows.md index 15397cced0..49835876ad 100644 --- a/docs/sources/get-started/run/windows.md +++ b/docs/sources/get-started/run/windows.md @@ -19,11 +19,11 @@ To verify that {{< param "PRODUCT_NAME" >}} is running as a Windows Service: 1. Type: `services.msc` and click **OK**. -1. Scroll down to find the **{{< param "FULL_PRODUCT_NAME" >}}** service and verify that the **Status** is **Running**. +1. Scroll down to find the **{{< param "PRODUCT_NAME" >}}** service and verify that the **Status** is **Running**. ## View {{% param "PRODUCT_NAME" %}} logs -When running on Windows, {{< param "PRODUCT_NAME" >}} writes its logs to Windows Event Logs with an event source name of **{{< param "FULL_PRODUCT_NAME" >}}**. +When running on Windows, {{< param "PRODUCT_NAME" >}} writes its logs to Windows Event Logs with an event source name of **{{< param "PRODUCT_NAME" >}}**. To view the logs, perform the following steps: diff --git a/docs/sources/reference/cli/run.md b/docs/sources/reference/cli/run.md index 48fee0b1a9..b2a15111cd 100644 --- a/docs/sources/reference/cli/run.md +++ b/docs/sources/reference/cli/run.md @@ -130,7 +130,7 @@ The current state of a clustered {{< param "PRODUCT_NAME" >}} is shown on the cl ## Configuration conversion (beta) -When you use the `--config.format` command-line argument with a value other than `alloy`, {{< param "PRODUCT_NAME" >}} converts the configuration file from the source format to River and immediately starts running with the new configuration. +When you use the `--config.format` command-line argument with a value other than `alloy`, {{< param "PRODUCT_NAME" >}} converts the configuration file from the source format to {{< param "PRODUCT_NAME" >}} and immediately starts running with the new configuration. This conversion uses the converter API described in the [alloy convert][] docs. If you include the `--config.bypass-conversion-errors` command-line argument, diff --git a/docs/sources/reference/components/loki.process.md b/docs/sources/reference/components/loki.process.md index a330f063ff..9f9d344d9b 100644 --- a/docs/sources/reference/components/loki.process.md +++ b/docs/sources/reference/components/loki.process.md @@ -926,7 +926,7 @@ The `expression` field needs to be a RE2 regex string. Every matched capture group is added to the extracted map, so it must be named like: `(?Pre)`. The name of the capture group is then used as the key in the extracted map for the matched value. -Because of how River strings work, any backslashes in `expression` must be escaped with a double backslash; for example `"\\w"` or `"\\S+"`. +Because of how {{< param "PRODUCT_NAME" >}} syntax strings work, any backslashes in `expression` must be escaped with a double backslash; for example `"\\w"` or `"\\S+"`. If the `source` is empty or missing, then the stage parses the log line itself. If it's set, the stage parses a previously extracted value with the same name. @@ -995,7 +995,7 @@ The replaced value is assigned back to the `source` key. The `expression` must be a valid RE2 regex. Every named capture group `(?Pre)` is set into the extracted map with its name. -Because of how River treats backslashes in double-quoted strings, note that all backslashes in a regex expression must be escaped like `"\\w*"`. +Because of how {{< param "PRODUCT_NAME" >}} syntax treats backslashes in double-quoted strings, note that all backslashes in a regex expression must be escaped like `"\\w*"`. Let's see how this works with the following log line and stage. Since `source` is omitted, the replacement occurs on the log line itself. diff --git a/docs/sources/reference/components/otelcol.connector.spanmetrics.md b/docs/sources/reference/components/otelcol.connector.spanmetrics.md index d010475c90..9c2ea58623 100644 --- a/docs/sources/reference/components/otelcol.connector.spanmetrics.md +++ b/docs/sources/reference/components/otelcol.connector.spanmetrics.md @@ -622,7 +622,7 @@ This problem can be solved by doing **either** of the following: - **Recommended approach:** Prior to `otelcol.connector.spanmetrics`, remove all resource attributes from the incoming spans which are not needed by `otelcol.connector.spanmetrics`. - {{< collapse title="Example River configuration to remove unnecessary resource attributes." >}} + {{< collapse title="Example {{< param "PRODUCT_NAME" >}} configuration to remove unnecessary resource attributes." >}} ```river otelcol.receiver.otlp "default" { http {} @@ -690,7 +690,7 @@ This has the advantage that the resource attributes will be visible as metric la However, the {{< term "cardinality" >}}cardinality{{< /term >}} of the metrics may be much higher, which could increase the cost of storing and querying them. The example below uses the [merge_maps][] OTTL function. - {{< collapse title="Example River configuration to add all resource attributes as metric datapoint attributes." >}} + {{< collapse title="Example {{< param "PRODUCT_NAME" >}} configuration to add all resource attributes as metric datapoint attributes." >}} ```river otelcol.receiver.otlp "default" { http {} diff --git a/docs/sources/reference/components/otelcol.processor.attributes.md b/docs/sources/reference/components/otelcol.processor.attributes.md index c76c385b79..ac78b387df 100644 --- a/docs/sources/reference/components/otelcol.processor.attributes.md +++ b/docs/sources/reference/components/otelcol.processor.attributes.md @@ -296,7 +296,7 @@ otelcol.processor.attributes "default" { // it will be updated. // // Note: The regex pattern is enclosed in backticks instead of quotation marks. - // This constitutes a raw River string, and lets us avoid the need to escape backslash characters. + // This constitutes a raw {{< param "PRODUCT_NAME" >}} syntax string, and lets us avoid the need to escape backslash characters. action { key = "example_user_key" pattern = `\/api\/v1\/document\/(?P.*)\/update\/(?P.*)$` diff --git a/docs/sources/reference/components/otelcol.processor.filter.md b/docs/sources/reference/components/otelcol.processor.filter.md index 75746831b1..407172f2f3 100644 --- a/docs/sources/reference/components/otelcol.processor.filter.md +++ b/docs/sources/reference/components/otelcol.processor.filter.md @@ -34,8 +34,8 @@ In addition to the [standard OTTL Converter functions][OTTL Converter functions] * `sum([1, 2, 3, 4]) + (10 / 1) - 1` {{< admonition type="note" >}} -Raw River strings can be used to write OTTL statements. -For example, the OTTL statement `attributes["grpc"] == true` is written in River as \`attributes["grpc"] == true\` +Raw {{< param "PRODUCT_NAME" >}} syntax strings can be used to write OTTL statements. +For example, the OTTL statement `attributes["grpc"] == true` is written in {{< param "PRODUCT_NAME" >}} syntax as \`attributes["grpc"] == true\` {{< /admonition >}} {{< admonition type="note" >}} @@ -212,7 +212,7 @@ otelcol.processor.filter "default" { } ``` -Each `"` is [escaped][river-strings] with `\"` inside the River string. +Each `"` is [escaped][river-strings] with `\"` inside the {{< param "PRODUCT_NAME" >}} syntax string. ### Drop metrics based on either of two criteria @@ -240,7 +240,7 @@ otelcol.processor.filter "default" { ``` -Some values in the River string are [escaped][river-strings]: +Some values in the {{< param "PRODUCT_NAME" >}} syntax string are [escaped][river-strings]: * `\` is escaped with `\\` * `"` is escaped with `\"` @@ -271,10 +271,10 @@ otelcol.processor.filter "default" { } ``` -Each `"` is [escaped][river-strings] with `\"` inside the River string. +Each `"` is [escaped][river-strings] with `\"` inside the {{< param "PRODUCT_NAME" >}} syntax string. -Some values in the River strings are [escaped][river-strings]: +Some values in the {{< param "PRODUCT_NAME" >}} syntax strings are [escaped][river-strings]: * `\` is escaped with `\\` * `"` is escaped with `\"` diff --git a/docs/sources/reference/components/otelcol.processor.resourcedetection.md b/docs/sources/reference/components/otelcol.processor.resourcedetection.md index b9d04d2121..94c719c25e 100644 --- a/docs/sources/reference/components/otelcol.processor.resourcedetection.md +++ b/docs/sources/reference/components/otelcol.processor.resourcedetection.md @@ -62,12 +62,12 @@ Name | Type | Description * `openshift` * `kubernetes_node` -`env` is the only detector that is not configured through a River block. +`env` is the only detector that is not configured through a block. The `env` detector reads resource information from the `OTEL_RESOURCE_ATTRIBUTES` environment variable. This variable must be in the format `=,=,...`, the details of which are currently pending confirmation in the OpenTelemetry specification. -If a detector other than `env` is needed, you can customize it with the relevant River block. +If a detector other than `env` is needed, you can customize it with the relevant block. For example, you can customize the `ec2` detector with the [ec2][] block. If you omit the [ec2][] block, the defaults specified in the [ec2][] block documentation are used. @@ -786,7 +786,7 @@ otelcol.processor.resourcedetection "default" { ### env and ec2 -There is no need to put in an `ec2 {}` River block. +There is no need to put in an `ec2 {}` block. The `ec2` defaults are applied automatically, as specified in [ec2][]. ```river @@ -803,7 +803,7 @@ otelcol.processor.resourcedetection "default" { ### ec2 with default resource attributes -There is no need to put in a `ec2 {}` River block. +There is no need to put in a `ec2 {}` block. The `ec2` defaults are applied automatically, as specified in [ec2][]. ```river @@ -850,7 +850,7 @@ otelcol.processor.resourcedetection "default" { This example uses the default `node_from_env_var` option of `K8S_NODE_NAME`. -There is no need to put in a `kubernetes_node {}` River block. +There is no need to put in a `kubernetes_node {}` block. The `kubernetes_node` defaults are applied automatically, as specified in [kubernetes_node][]. ```river diff --git a/docs/sources/reference/components/otelcol.processor.transform.md b/docs/sources/reference/components/otelcol.processor.transform.md index 03dd8bfe3d..1ccd6e1023 100644 --- a/docs/sources/reference/components/otelcol.processor.transform.md +++ b/docs/sources/reference/components/otelcol.processor.transform.md @@ -38,15 +38,15 @@ there is also a set of metrics-only functions: * `sum([1, 2, 3, 4]) + (10 / 1) - 1` {{< admonition type="note" >}} -There are two ways of inputting strings in River configuration files: -* Using quotation marks ([normal River strings][river-strings]). Characters such as `\` and +There are two ways of inputting strings in {{< param "PRODUCT_NAME" >}} configuration files: +* Using quotation marks ([normal {{< param "PRODUCT_NAME" >}} syntax strings][river-strings]). Characters such as `\` and `"` must be escaped by preceding them with a `\` character. -* Using backticks ([raw River strings][river-raw-strings]). No characters must be escaped. +* Using backticks ([raw {{< param "PRODUCT_NAME" >}} syntax strings][river-raw-strings]). No characters must be escaped. However, it's not possible to have backticks inside the string. For example, the OTTL statement `set(description, "Sum") where type == "Sum"` can be written as: -* A normal River string: `"set(description, \"Sum\") where type == \"Sum\""`. -* A raw River string: ``` `set(description, "Sum") where type == "Sum"` ```. +* A normal {{< param "PRODUCT_NAME" >}} syntax string: `"set(description, \"Sum\") where type == \"Sum\""`. +* A raw {{< param "PRODUCT_NAME" >}} syntax string: ``` `set(description, "Sum") where type == "Sum"` ```. Raw strings are generally more convenient for writing OTTL statements. @@ -301,7 +301,7 @@ otelcol.processor.transform "default" { Each statement is enclosed in backticks instead of quotation marks. This constitutes a [raw string][river-raw-strings], and lets us avoid the need to escape -each `"` with a `\"` inside a [normal][river-strings] River string. +each `"` with a `\"` inside a [normal][river-strings] {{< param "PRODUCT_NAME" >}} syntax string. ### Rename a resource attribute @@ -351,7 +351,7 @@ otelcol.processor.transform "default" { Each statement is enclosed in backticks instead of quotation marks. This constitutes a [raw string][river-raw-strings], and lets us avoid the need to escape -each `"` with a `\"`, and each `\` with a `\\` inside a [normal][river-strings] River string. +each `"` with a `\"`, and each `\` with a `\\` inside a [normal][river-strings] {{< param "PRODUCT_NAME" >}} syntax string. ### Create an attribute from the contents of a log body @@ -378,7 +378,7 @@ otelcol.processor.transform "default" { Each statement is enclosed in backticks instead of quotation marks. This constitutes a [raw string][river-raw-strings], and lets us avoid the need to escape -each `"` with a `\"` inside a [normal][river-strings] River string. +each `"` with a `\"` inside a [normal][river-strings] {{< param "PRODUCT_NAME" >}} syntax string. ### Combine two attributes @@ -406,7 +406,7 @@ otelcol.processor.transform "default" { Each statement is enclosed in backticks instead of quotation marks. This constitutes a [raw string][river-raw-strings], and lets us avoid the need to escape -each `"` with a `\"` inside a [normal][river-strings] River string. +each `"` with a `\"` inside a [normal][river-strings] {{< param "PRODUCT_NAME" >}} syntax string. ### Parsing JSON logs @@ -458,7 +458,7 @@ otelcol.processor.transform "default" { Each statement is enclosed in backticks instead of quotation marks. This constitutes a [raw string][river-raw-strings], and lets us avoid the need to escape -each `"` with a `\"`, and each `\` with a `\\` inside a [normal][river-strings] River string. +each `"` with a `\"`, and each `\` with a `\\` inside a [normal][river-strings] {{< param "PRODUCT_NAME" >}} syntax string. ### Various transformations of attributes and status codes @@ -559,7 +559,7 @@ otelcol.exporter.otlp "default" { Each statement is enclosed in backticks instead of quotation marks. This constitutes a [raw string][river-raw-strings], and lets us avoid the need to escape -each `"` with a `\"`, and each `\` with a `\\` inside a [normal][river-strings] River string. +each `"` with a `\"`, and each `\` with a `\\` inside a [normal][river-strings] {{< param "PRODUCT_NAME" >}} syntax string. [river-strings]: ../../../concepts/config-language/expressions/types_and_values/#strings [river-raw-strings]: ../../../concepts/config-language/expressions/types_and_values/#raw-strings diff --git a/docs/sources/reference/components/prometheus.exporter.gcp.md b/docs/sources/reference/components/prometheus.exporter.gcp.md index ef4dbf20a1..2f0c8ea0e5 100644 --- a/docs/sources/reference/components/prometheus.exporter.gcp.md +++ b/docs/sources/reference/components/prometheus.exporter.gcp.md @@ -55,7 +55,7 @@ You can use the following arguments to configure the exporter's behavior. Omitted fields take their default values. {{< admonition type="note" >}} -Please note that if you are supplying a list of strings for the `extra_filters` argument, any string values within a particular filter string must be enclosed in escaped double quotes. For example, `loadbalancing.googleapis.com:resource.labels.backend_target_name="sample-value"` must be encoded as `"loadbalancing.googleapis.com:resource.labels.backend_target_name=\"sample-value\""` in the River config. +Please note that if you are supplying a list of strings for the `extra_filters` argument, any string values within a particular filter string must be enclosed in escaped double quotes. For example, `loadbalancing.googleapis.com:resource.labels.backend_target_name="sample-value"` must be encoded as `"loadbalancing.googleapis.com:resource.labels.backend_target_name=\"sample-value\""` in the {{< param "PRODUCT_NAME" >}} configuration. {{< /admonition >}} | Name | Type | Description | Default | Required | diff --git a/docs/sources/reference/config-blocks/import.git.md b/docs/sources/reference/config-blocks/import.git.md index 5e4510a764..800a1859e2 100644 --- a/docs/sources/reference/config-blocks/import.git.md +++ b/docs/sources/reference/config-blocks/import.git.md @@ -38,8 +38,8 @@ You must set the `repository` attribute to a repository address that Git would r When provided, the `revision` attribute must be set to a valid branch, tag, or commit SHA within the repository. You must set the `path` attribute to a path accessible from the repository's root. -It can either be a River file such as `FILE_NAME.alloy` or `DIR_NAME/FILE_NAME.alloy` or -a directory containing River files such as `DIR_NAME` or `.` if the River files are stored at the root +It can either be an {{< param "PRODUCT_NAME" >}} configuration file such as `FILE_NAME.alloy` or `DIR_NAME/FILE_NAME.alloy` or +a directory containing {{< param "PRODUCT_NAME" >}} configuration files such as `DIR_NAME` or `.` if the {{< param "PRODUCT_NAME" >}} configuration files are stored at the root of the repository. If `pull_frequency` isn't `"0s"`, the Git repository is pulled for updates at the frequency specified. diff --git a/docs/sources/reference/stdlib/json_decode.md b/docs/sources/reference/stdlib/json_decode.md index 6bc68ca250..af2cd366e1 100644 --- a/docs/sources/reference/stdlib/json_decode.md +++ b/docs/sources/reference/stdlib/json_decode.md @@ -8,10 +8,10 @@ title: json_decode # json_decode -The `json_decode` function decodes a string representing JSON into a River value. +The `json_decode` function decodes a string representing JSON into an {{< param "PRODUCT_NAME" >}} value. `json_decode` fails if the string argument provided can't be parsed as JSON. -A common use case of `json_decode` is to decode the output of a [`local.file`][] component to a River value. +A common use case of `json_decode` is to decode the output of a [`local.file`][] component to an {{< param "PRODUCT_NAME" >}} value. > Remember to escape double quotes when passing JSON string literals to `json_decode`. > diff --git a/docs/sources/reference/stdlib/json_path.md b/docs/sources/reference/stdlib/json_path.md index dda12738a0..cca63b8492 100644 --- a/docs/sources/reference/stdlib/json_path.md +++ b/docs/sources/reference/stdlib/json_path.md @@ -14,7 +14,7 @@ The function expects two strings. The first string is the JSON string used look `json_path` always returns a list of values. If the JSONPath expression doesn't match any values, an empty list is returned. -A common use case of `json_path` is to decode and filter the output of a [`local.file`][] or [`remote.http`][] component to a River value. +A common use case of `json_path` is to decode and filter the output of a [`local.file`][] or [`remote.http`][] component to an {{< param "PRODUCT_NAME" >}} syntax value. > Remember to escape double quotes when passing JSON string literals to `json_path`. > diff --git a/docs/sources/tasks/configure/_index.md b/docs/sources/tasks/configure/_index.md index 90b4d68c90..844aa85187 100644 --- a/docs/sources/tasks/configure/_index.md +++ b/docs/sources/tasks/configure/_index.md @@ -9,7 +9,7 @@ weight: 90 # Configure {{% param "FULL_PRODUCT_NAME" %}} You can configure {{< param "PRODUCT_NAME" >}} after it is [installed][Install]. -The default River configuration file for {{< param "PRODUCT_NAME" >}} is located at: +The default configuration file for {{< param "PRODUCT_NAME" >}} is located at: * Linux: `/etc/alloy/config.alloy` * macOS: `$(brew --prefix)/etc/alloy/config.alloy` diff --git a/docs/sources/tasks/configure/configure-macos.md b/docs/sources/tasks/configure/configure-macos.md index 96ea96005e..e8f8fb1823 100644 --- a/docs/sources/tasks/configure/configure-macos.md +++ b/docs/sources/tasks/configure/configure-macos.md @@ -36,7 +36,7 @@ To customize the {{< param "PRODUCT_NAME" >}} service on macOS, perform the foll 1. Modify the `service` section as desired to change things such as: - * The River configuration file used by {{< param "PRODUCT_NAME" >}}. + * The configuration file used by {{< param "PRODUCT_NAME" >}}. * Flags passed to the {{< param "PRODUCT_NAME" >}} binary. * Location of log files. diff --git a/docs/sources/tasks/migrate/from-operator.md b/docs/sources/tasks/migrate/from-operator.md index 8b3037cb62..bf7ca9ceb7 100644 --- a/docs/sources/tasks/migrate/from-operator.md +++ b/docs/sources/tasks/migrate/from-operator.md @@ -59,7 +59,7 @@ This guide provides some steps to get started with {{< param "PRODUCT_NAME" >}} helm upgrade alloy-metrics grafana/alloy -i -n monitoring -f values.yaml --set-file alloy.configMap.content=alloy.alloy ``` - This command uses the `--set-file` flag to pass the configuration file as a Helm value so that you can continue to edit it as a regular River file. + This command uses the `--set-file` flag to pass the configuration file as a Helm value so that you can continue to edit it as a regular {{< param "PRODUCT_NAME" >}} configuration file. ## Convert `MetricsIntances` to {{% param "PRODUCT_NAME" %}} components @@ -70,7 +70,7 @@ A `MetricsInstance` resource primarily defines: You can use these functions in {{< param "PRODUCT_NAME" >}} with the `prometheus.remote_write`, `prometheus.operator.podmonitors`, `prometheus.operator.servicemonitors`, and `prometheus.operator.probes` components respectively. -The following River sample is equivalent to the `MetricsInstance` from the [operator guide][]. +The following {{< param "PRODUCT_NAME" >}} syntax sample is equivalent to the `MetricsInstance` from the [operator guide][]. ```river diff --git a/docs/sources/tasks/migrate/from-prometheus.md b/docs/sources/tasks/migrate/from-prometheus.md index 985c8fcba6..7e9ac9c9a4 100644 --- a/docs/sources/tasks/migrate/from-prometheus.md +++ b/docs/sources/tasks/migrate/from-prometheus.md @@ -136,7 +136,7 @@ remote_write: password: ``` -The convert command takes the YAML file as input and outputs a [River][] file. +The convert command takes the YAML file as input and outputs a [{{< param "PRODUCT_NAME" >}} configuration][] file. ```shell alloy convert --source-format=prometheus --output= @@ -208,5 +208,5 @@ The following list is specific to the convert command and not {{< param "PRODUCT [run]: ../../../reference/cli/run/ [run alloy]: ../../../get-started/run/ [DebuggingUI]: ../../tasks/debug/ -[River]: ../../../concepts/config-language/ +[{{< param "PRODUCT_NAME" >}} configuration]: ../../../concepts/config-language/ [UI]: ../../debug/#alloy-ui diff --git a/docs/sources/tasks/migrate/from-promtail.md b/docs/sources/tasks/migrate/from-promtail.md index d0267ee610..31ff2a9a40 100644 --- a/docs/sources/tasks/migrate/from-promtail.md +++ b/docs/sources/tasks/migrate/from-promtail.md @@ -126,7 +126,7 @@ scrape_configs: __path__: /var/log/*.log ``` -The convert command takes the YAML file as input and outputs a [River][] file. +The convert command takes the YAML file as input and outputs a [{{< param "PRODUCT_NAME" >}} configuration][] file. ```shell alloy convert --source-format=promtail --output= @@ -189,5 +189,5 @@ The following list is specific to the convert command and not {{< param "PRODUCT [run]: ../../../reference/cli/run/ [run alloy]: ../../../get-started/run/ [DebuggingUI]: ../../../tasks/debug/ -[River]: ../../../concepts/config-language/ +[{{< param "PRODUCT_NAME" >}} configuration]: ../../../concepts/config-language/ [UI]: ../../tasks/debug/#alloy-ui diff --git a/docs/sources/tasks/migrate/from-static.md b/docs/sources/tasks/migrate/from-static.md index fb3980b804..1d70bc35a0 100644 --- a/docs/sources/tasks/migrate/from-static.md +++ b/docs/sources/tasks/migrate/from-static.md @@ -172,7 +172,7 @@ logs: - url: https://USER_ID:API_KEY@logs-prod3.grafana.net/loki/api/v1/push ``` -The convert command takes the YAML file as input and outputs a [River][] file. +The convert command takes the YAML file as input and outputs a [{{< param "PRODUCT_NAME" >}} configuration][] file. ```shell alloy convert --source-format=static --output= @@ -316,7 +316,7 @@ The following list is specific to the convert command and not {{< param "PRODUCT [run]: ../../../reference/cli/run/ [run alloy]: ../../../get-started/run/ [DebuggingUI]: ../../debug/ -[River]: ../../../concepts/config-language/ +[{{< param "PRODUCT_NAME" >}} configuration]: ../../../concepts/config-language/ [Integrations next]: https://grafana.com/docs/agent/latest/static/configuration/integrations/integrations-next/ diff --git a/docs/sources/tutorials/flow-by-example/first-components-and-stdlib/index.md b/docs/sources/tutorials/flow-by-example/first-components-and-stdlib/index.md index 1e81d65ced..28fecdc459 100644 --- a/docs/sources/tutorials/flow-by-example/first-components-and-stdlib/index.md +++ b/docs/sources/tutorials/flow-by-example/first-components-and-stdlib/index.md @@ -1,6 +1,6 @@ --- canonical: https://grafana.com/docs/alloy/latest/tutorials/flow-by-example/first-components-and-stdlib/ -description: Learn about the basics of River and the configuration language +description: Learn about the basics of the {{< param "PRODUCT_NAME" >}} configuration syntax title: First components and introducing the standard library weight: 20 --- @@ -10,15 +10,15 @@ weight: 20 This tutorial covers the basics of the {{< param "PRODUCT_NAME" >}} configuration syntax and the standard library. It introduces a basic pipeline that collects metrics from the host and sends them to Prometheus. -## River basics +## {{< param "PRODUCT_NAME" >}} configuration syntax basics **Recommended reading** - [Configuration language][] - [Configuration language concepts][] -[River][] is an HCL-inspired configuration language used to configure {{< param "PRODUCT_NAME" >}}. -A River file is comprised of three things: +The [{{< param "PRODUCT_NAME" >}} configuration syntax][] is an HCL-inspired configuration language used to configure {{< param "PRODUCT_NAME" >}}. +An {{< param "PRODUCT_NAME" >}} configuration file is comprised of three things: 1. **Attributes** @@ -53,10 +53,11 @@ The default log level is `info` and the default log format is `logfmt`. Try pasting this into `config.alloy` and running `/path/to/alloy run config.alloy` to see what happens. - Congratulations, you've just written your first River file! You've also just written your first {{< param "PRODUCT_NAME" >}} configuration file. This configuration won't do anything, so let's add some components to it. + Congratulations, you've just written your first {{< param "PRODUCT_NAME" >}} configuration file. + This configuration won't do anything, so let's add some components to it. {{< admonition type="note" >}} -Comments in River are prefixed with `//` and are single-line only. For example: `// This is a comment`. +Comments in {{< param "PRODUCT_NAME" >}} syntax are prefixed with `//` and are single-line only. For example: `// This is a comment`. {{< /admonition >}} ## Components @@ -282,7 +283,7 @@ You will also look at using different components to process metrics and logs bef [Configuration language concepts]: ../../../concepts/configuration_language/ [Standard library documentation]: ../../../reference/stdlib/ [node_exporter]: https://github.com/prometheus/node_exporter -[River]: https://github.com/grafana/river +[{{< param "PRODUCT_NAME" >}} configuration syntax]: https://github.com/grafana/river [prometheus.exporter.redis]: ../../../reference/components/prometheus.exporter.redis/ [http://localhost:3000/explore]: http://localhost:3000/explore [prometheus.exporter.unix]: ../../../reference/components/prometheus.exporter.unix/ diff --git a/docs/sources/tutorials/flow-by-example/get-started.md b/docs/sources/tutorials/flow-by-example/get-started.md index 7b82751edf..896d0c1e9d 100644 --- a/docs/sources/tutorials/flow-by-example/get-started.md +++ b/docs/sources/tutorials/flow-by-example/get-started.md @@ -7,11 +7,11 @@ weight: 10 ## Who is this for? -This set of tutorials contains a collection of examples that build on each other to demonstrate how to configure and use [{{< param "PRODUCT_NAME" >}}][alloy]. It assumes you have a basic understanding of what {{< param "PRODUCT_NAME" >}} is and telemetry collection in general. It also assumes a base level of familiarity with Prometheus and PromQL, Loki and LogQL, and basic Grafana navigation. It assumes no knowledge of {{< param "PRODUCT_NAME" >}} or River concepts. +This set of tutorials contains a collection of examples that build on each other to demonstrate how to configure and use [{{< param "PRODUCT_NAME" >}}][alloy]. It assumes you have a basic understanding of what {{< param "PRODUCT_NAME" >}} is and telemetry collection in general. It also assumes a base level of familiarity with Prometheus and PromQL, Loki and LogQL, and basic Grafana navigation. It assumes no knowledge of the {{< param "PRODUCT_NAME" >}} configuration syntax concepts. ## What is {{% param "PRODUCT_NAME" %}}? -{{< param "PRODUCT_NAME" >}} uses a declarative configuration language that allows you to define a pipeline of telemetry collection, processing, and output. It is built on top of the [River][] configuration language, which is designed to be fast, simple, and debuggable. +{{< param "PRODUCT_NAME" >}} uses a declarative configuration language that allows you to define a pipeline of telemetry collection, processing, and output. It is built on top of the [{{< param "PRODUCT_NAME" >}}][river] configuration language, which is designed to be fast, simple, and debuggable. ## What do I need to get started? @@ -82,5 +82,5 @@ The tutorials are designed to be followed in order and generally build on each o The Recommended Reading sections in each tutorial provide a list of documentation topics. To help you understand the concepts used in the example, read the recommended topics in the order given. [alloy]: https://grafana.com/docs/alloy/latest/ -[River]: https://github.com/grafana/river +[river]: https://github.com/grafana/river [install]: ../../../get-started/install/binary/#install-alloy-as-a-standalone-binary