Skip to content
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.

Sign up for GitHub

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

[DOC] Remove --stability-level for Alloy v1.2 #3382

Merged
merged 6 commits into from
Jun 27, 2024
Merged

[DOC] Remove --stability-level for Alloy v1.2 #3382

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3f45163
Updates for Alloy 1.2
knylander-grafana Jun 21, 2024
48b18d1
Update docs/sources/configure-client/grafana-agent/java/_index.md
knylander-grafana Jun 21, 2024
0d1ad05
Merge branch 'main' into updates-for-alloy-1-2
knylander-grafana Jun 24, 2024
01ed3e3
Updates for languages for alloy and agent
knylander-grafana Jun 24, 2024
70d9aa4
Update docs/sources/configure-client/grafana-agent/java/_index.md
knylander-grafana Jun 24, 2024
b2f3252
Update docs/sources/configure-client/grafana-agent/java/_index.md
knylander-grafana Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/sources/configure-client/grafana-agent/go_pull.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,10 @@ and `pyroscope.scrape`.
```

2. Start the collector:
* To start Grafana Alloy, replace `configuration.alloy` with your configuration file name: <br> `alloy run --stability.level=public-preview configuration.alloy`
The `stability.level` option is required for `pyroscope.scrape`. For more information about `stability.level`, refer to [The run command](https://grafana.com/docs/alloy/latest/reference/cli/run/#permitted-stability-levels) documentation.

* To start Grafana Alloy v1.2: Replace `configuration.alloy` with your configuration file name: <br> `alloy run configuration.alloy`
* To start Grafana Alloy v1.0/1.1: Replace `configuration.alloy` with your configuration file name: <br> `alloy run --stability.level=public-preview configuration.alloy`
The `stability.level` option is required for `pyroscope.scrape` with Alloy v1.0 or v1.1. For more information about `stability.level`, refer to [The run command](https://grafana.com/docs/alloy/latest/reference/cli/run/#permitted-stability-levels) documentation.
* To start Grafana Agent, replace `configuration.river` with your configuration file name: <br> ` grafana-agent-flow run configuration.river`

3. Open a browser to http://localhost:4040. The page should list profiles.
Expand Down
40 changes: 26 additions & 14 deletions docs/sources/configure-client/grafana-agent/java/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ weight: 20

Grafana Alloy and Grafana Agent in [Flow mode](/docs/agent/latest/flow/) support Java profiling.

Written in the
[River](/docs/agent/latest/flow/config-language/) language, the configuration file is composed of components that are used to collect,
Written
knylander-grafana marked this conversation as resolved.
Show resolved Hide resolved

The collector configuration file is composed of components that are used to collect,
transform, and send data.
Alloy configuration files use [configuration syntax](https://grafana.com/docs/alloy/latest/concepts/configuration-syntax/).
knylander-grafana marked this conversation as resolved.
Show resolved Hide resolved
Agent Flow files use the [River](/docs/agent/latest/flow/config-language/) language.

{{< docs/shared lookup="agent-deprecation.md" source="alloy" version="next" >}}

Expand Down Expand Up @@ -52,21 +55,21 @@ Pyroscope Server or [Grafana Cloud](/products/cloud/).
The special label `__process_pid__` _must always_ be present in each target of `targets` and corresponds to the `PID` of
the process to profile.

The special label `service_name` is required and must always be present. If `service_name` is not specified, `pyroscope.java`
attempts to infer it from discovery meta labels. If `service_name` is not specified and could not be inferred, then it is
set to `unspecified`.
The special label `service_name` is required and must always be present.
If `service_name` isn't specified, `pyroscope.java` attempts to infer it from discovery meta labels.
If `service_name` isn't specified and couldn't be inferred, then it's set to `unspecified`.

The `profiling_config` block describes how async-profiler is invoked.

The following arguments are supported:
It supports the following arguments:

| Name | Type | Description | Default | Required |
|---------------|------------|----------------------------------------------------------------------------------------------------------|---------|----------|
| `interval` | `duration` | How frequently to collect profiles from the targets. | "60s" | no |
| `cpu` | `bool` | A flag to enable cpu profiling, using `itimer` async-profiler event. | true | no |
| `sample_rate` | `int` | CPU profiling sample rate. It is converted from Hz to interval and passed as `-i` arg to async-profiler. | 100 | no |
| `alloc` | `string` | Allocation profiling sampling configuration It is passed as `--alloc` arg to async-profiler. | "512k" | no |
| `lock` | `string` | Lock profiling sampling configuration. It is passed as `--lock` arg to async-profiler. | "10ms" | no |
| `cpu` | `bool` | A flag to enable CPU profiling, using `itimer` async-profiler event. | true | no |
| `sample_rate` | `int` | CPU profiling sample rate. It's converted from Hz to interval and passed as `-i` arg to async-profiler. | 100 | no |
| `alloc` | `string` | Allocation profiling sampling configuration It's passed as `--alloc` arg to async-profiler. | "512k" | no |
| `lock` | `string` | Lock profiling sampling configuration. It's passed as `--lock` arg to async-profiler. | "10ms" | no |

For more information on async-profiler configuration,
see [profiler-options](https://github.com/async-profiler/async-profiler?tab=readme-ov-file#profiler-options).
Expand All @@ -78,13 +81,22 @@ and `discover.process` components to work.

### Start the collector

To start Grafana Alloy, replace `configuration.alloy` with your configuration file name:
To start Grafana Alloy v1.2: Replace `configuration.alloy` with your configuration file name:

```bash
alloy run configuration.alloy
```

To start Grafana Alloy v1.0/1.1: Replace `configuration.alloy` with your configuration file name:

```bash
alloy run --stability.level=public-preview configuration.alloy
```

`alloy run --stability.level=public-preview configuration.alloy`
The `stability.level` option is required for `pyroscope.scrape` with Alloy v1.0 or v1.1. For more information about `stability.level`, refer to [The run command](https://grafana.com/docs/alloy/latest/reference/cli/run/#permitted-stability-levels) documentation.

The `stability.level` option is required for `pyroscope.scrape`. For more information about `stability.level`, refer to [The run command](https://grafana.com/docs/alloy/latest/reference/cli/run/#permitted-stability-levels) documentation.

To start Grafana Agent, replace `configuration.river` with your configuration file name:
To start Grafana Agent, replace `configuration.river` with your configuration filename:
` grafana-agent-flow run configuration.river`

### Send data to Grafana Cloud Profiles
Expand Down
Loading