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

Jump to bottom

docs: update usage example to reflect new repo layout #12

Merged
merged 5 commits into from
Apr 22, 2024
Merged

docs: update usage example to reflect new repo layout #12

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dab9161
docs: update usage example to reflect new repo layout
hbjydev Apr 11, 2024
7e2408a
docs: add warning about pyroscope being in public preview
hbjydev Apr 11, 2024
cf559ec
docs: module, not import
hbjydev Apr 12, 2024
dec2ae5
docs: resolve change requests in MR
hbjydev Apr 12, 2024
de9e549
Merge branch 'main' into patch-1
erikbaranowski Apr 22, 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
11 changes: 8 additions & 3 deletions modules/cloud/grafana/cloud/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Grafana Cloud Auto-Configuration Module

> [!WARNING]
> Currently, the Pyroscope functionality in this module is under the `public-preview` stability level. As such, to use this module, you will need to pass `--stability.level=public-preview` to your `alloy run` command.
>
> See the docs for [`pyroscope.write`](https://grafana.com/docs/alloy/latest/reference/components/pyroscope.write/) and [Grafana Labs' Release Lifecycle](https://grafana.com/docs/release-life-cycle/) for more info on this.

Module to interact with Grafana Cloud.

## Components
Expand Down Expand Up @@ -46,15 +51,15 @@ The token must have permissions to read stack information. The setup of these pe

```river
import.git "grafana_cloud" {
repository = "https://github.com/grafana/flow-modules.git"
repository = "https://github.com/grafana/alloy-modules.git"
revision = "main"
path = "modules/cloud/grafana.river"
path = "modules/cloud/grafana/cloud/module.alloy"
pull_frequency = "15m"
}

// get the receivers
grafana_cloud.stack "receivers" {
stack = "DashyMcDashFace"
stack_name = "DashyMcDashFace"
hbjydev marked this conversation as resolved.
Show resolved Hide resolved
token = "XXXXXXXXXXXXX"
}

Expand Down
Loading