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

Promote/ruler api #4132

Merged
merged 3 commits into from
Aug 18, 2021
Merged

Promote/ruler api #4132

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6cd90d
unmark the ruler api as experimental
owen-d Aug 10, 2021
8e6da98
deprecation notice for experimental prefix
owen-d Aug 10, 2021
9795da1
removes vendor changes, adds -ruler.enable-api (without experimental …
owen-d Aug 18, 2021
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
3 changes: 1 addition & 2 deletions docs/sources/configuration/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,6 @@ results_cache:

The `ruler_config` configures the Loki ruler.

<span style="background-color:#f3f973;">The Ruler API is experimental.</span>

```yaml
# URL of alerts return path.
Expand Down Expand Up @@ -753,7 +752,7 @@ ring:
[flush_period: <duration> | default = 1m]

# Enable the Ruler API.
# CLI flag: -experimental.ruler.enable-api
# CLI flag: -ruler.enable-api
[enable_api: <boolean> | default = false]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/rules/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ jobs:

One option to scale the Ruler is by scaling it horizontally. However, with multiple Ruler instances running they will need to coordinate to determine which instance will evaluate which rule. Similar to the ingesters, the Rulers establish a hash ring to divide up the responsibilities of evaluating rules.

The possible configurations are listed fully in the [configuration documentation](https://grafana.com/docs/loki/latest/configuration/), but in order to shard rules across multiple Rulers, the rules API must be enabled via flag (`-experimental.Ruler.enable-api`) or config file parameter. Secondly, the Ruler requires it's own ring be configured. From there the Rulers will shard and handle the division of rules automatically. Unlike ingesters, Rulers do not hand over responsibility: all rules are re-sharded randomly every time a Ruler is added to or removed from the ring.
The possible configurations are listed fully in the [configuration documentation](https://grafana.com/docs/loki/latest/configuration/), but in order to shard rules across multiple Rulers, the rules API must be enabled via flag (`-ruler.enable-api`) or config file parameter. Secondly, the Ruler requires it's own ring be configured. From there the Rulers will shard and handle the division of rules automatically. Unlike ingesters, Rulers do not hand over responsibility: all rules are re-sharded randomly every time a Ruler is added to or removed from the ring.

A full sharding-enabled Ruler example is:

Expand Down
7 changes: 6 additions & 1 deletion vendor/github.com/cortexproject/cortex/pkg/ruler/ruler.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.