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 note about --prometheus-url in local deployments #698

Merged
merged 3 commits into from
Feb 22, 2024

Conversation

agarciamontoro
Copy link
Member

Summary

Just a clarification identified in https://community.mattermost.com/core/pl/adw9x3jb43ngbjcknses4cgrth

Ticket Link

--

@agarciamontoro agarciamontoro added the 2: Dev Review Requires review by a core committer label Feb 20, 2024
docs/compare.md Outdated
@@ -8,6 +8,8 @@ After a load test is complete, a report can be generated and saved to a file whi
go run ./cmd/ltctl report generate --output=base.out --label=base "2020-06-23 07:23:35" "2020-06-23 07:33:35"
```

Note that in the case of a local deployment, you'll need to set the `--prometheus-url ` flag to the URL of the Prometheus server from where the tool will scrape the results.
Copy link
Contributor

Choose a reason for hiding this comment

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

this is great, but I think there is a need to add a link that points to how to set this up in order to collect the data in the prometheus server.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do you mean about how to set up a Prometheus server?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes..

Copy link
Member Author

Choose a reason for hiding this comment

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

Check the latest commit f9b28ab and let me know if that's what you had in mind!

Copy link
Contributor

Choose a reason for hiding this comment

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

This is great!

docs/compare.md Outdated
@@ -8,6 +8,8 @@ After a load test is complete, a report can be generated and saved to a file whi
go run ./cmd/ltctl report generate --output=base.out --label=base "2020-06-23 07:23:35" "2020-06-23 07:33:35"
```

Note that in the case of a local deployment, you'll need to set the `--prometheus-url ` flag to the URL of the Prometheus server from where the tool will scrape the results.
Copy link
Member

Choose a reason for hiding this comment

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

Wondering if we can make the tool a bit more intuitive so that one doesn't have to read through so much documentation? Is it possible that running the command without the url throws an error like "please pass --promtheus-url" or "invalid prometheus-url, check if you have set it"?

@agarciamontoro
Copy link
Member Author

I created a new ticket to fix the underlying problems here: https://mattermost.atlassian.net/browse/MM-56949

For this PR, I added a new comment when retrieving the URL from the Terraform deployment so that users know what's happening.

@agarciamontoro agarciamontoro merged commit 89471d6 into master Feb 22, 2024
1 check passed
@agarciamontoro agarciamontoro deleted the prometheus.url.docs branch February 22, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2: Dev Review Requires review by a core committer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants