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.

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

Add documentation for recording rule backfiller #8674

Merged

Conversation

JessicaGreben
Copy link
Contributor

This PR adds documentation for Issue #11 and #8667.

Signed-off-by: jessicagreben <jessicagrebens@gmail.com>
Copy link
Member

@roidelapluie roidelapluie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this!

cmd/promtool/main.go Outdated Show resolved Hide resolved
docs/storage.md Outdated Show resolved Hide resolved
docs/storage.md Outdated

### Usage

```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This copy and paste seems fragile, I would remove it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe say: To see all the options, use promtool tsdb create-blocks-from rules --help

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah i was thinking the same. will change

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could setup auto-generated one, but if we do, let's make Pr at some point for all commands (:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bwplotka Is there somewhere we already have the auto-generated one setup? Or would that be something new? If we want to proceed with that, is it worth creating an issue for it?

docs/storage.md Outdated Show resolved Hide resolved
docs/storage.md Outdated Show resolved Hide resolved
docs/storage.md Outdated Show resolved Hide resolved
docs/storage.md Show resolved Hide resolved
docs/storage.md Outdated Show resolved Hide resolved
Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! It looks great, but I agree with @roidelapluie suggestions. Let's address them and then LGTM 🚀

docs/storage.md Outdated

### Usage

```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could setup auto-generated one, but if we do, let's make Pr at some point for all commands (:

Signed-off-by: jessicagreben <jessicagrebens@gmail.com>
Signed-off-by: jessicagreben <jessicagrebens@gmail.com>
@roidelapluie roidelapluie merged commit 731545a into prometheus:main Apr 1, 2021
@roidelapluie
Copy link
Member

Thanks!

@JessicaGreben JessicaGreben deleted the jg/add-docs-rule-backfiller branch April 2, 2021 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants