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

Document how to bin/scratch launched items into Grafana #10382

Merged
merged 1 commit into from
Feb 10, 2022

Conversation

quodlibetor
Copy link
Contributor

The existing docs had examples that were correct, but there was no
documentation for exactly what was required, making it difficult to be sure
that everything worked if you were building something from, ahem, scratch.

Checklist

  • [n/a] This PR has adequate test coverage / QA involvement has been duly considered.
  • [n/a] This PR adds a release note for any user-facing behavior changes.

Copy link
Member

@benesch benesch left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! I wonder if we should make scrape_benchmark_numbers the default...

doc/developer/scratch.md Outdated Show resolved Hide resolved
doc/developer/scratch.md Outdated Show resolved Hide resolved
doc/developer/scratch.md Outdated Show resolved Hide resolved
doc/developer/scratch.md Outdated Show resolved Hide resolved
doc/developer/scratch.md Outdated Show resolved Hide resolved
doc/developer/scratch.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ruchirK ruchirK left a comment

Choose a reason for hiding this comment

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

LGTM! I also think scrape_benchmark_numbers true is a nice default unless theres some important reason we don't already do so

doc/developer/scratch.md Outdated Show resolved Hide resolved
to observe the instance.
* `purpose`: is used as a filter in the Grafana UI. You can use this to group all your instances
(e.g. set it to `myname-debugging`) or set it to `load-test` or `benchmark`.
* `test` is both used by scratch to determine which test to execute, and displays as an additional
Copy link
Contributor

Choose a reason for hiding this comment

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

wait so just to double check - if the value of test doesn't match whats actually run in the launch script will that be a problem? I couldn't tell if the test field was purely informational and it seems like no?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Test is used to determine what test to automatically run by the scratch script. If it is invalid then nothing will be run automatically.

Copy link
Member

Choose a reason for hiding this comment

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

Test is used to determine what test to automatically run by the scratch script.

Hrm, are you sure? Where are you seeing that? Am I just missing it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, no I must have been remembering the way it used to work, or just wrong.

The existing docs had examples that were correct, but there was no
documentation for exactly what was required, making it difficult to be sure
that everything worked if you were building something from, ahem, scratch.
@quodlibetor quodlibetor enabled auto-merge (squash) February 10, 2022 22:28
@quodlibetor quodlibetor merged commit b87ecbf into MaterializeInc:main Feb 10, 2022
@quodlibetor quodlibetor deleted the doc-scratch-grafana branch February 10, 2022 22:31
wangandi pushed a commit to wangandi/materialize that referenced this pull request Apr 11, 2022
…nc#10382)

The existing docs had examples that were correct, but there was no
documentation for exactly what was required, making it difficult to be sure
that everything worked if you were building something from, ahem, scratch.
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.

3 participants