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

dashboard: add code status rate and apdex, improvement checks, update… #98

Merged
merged 8 commits into from
Jan 19, 2023

Conversation

jwcastillo
Copy link
Contributor

new dashboard version

add:

  • samples, for test dashboard
  • apdex session
  • status code rate

update:

  • readme
  • all panels dashboard

remove:

  • custom metrics panel

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
samples/error.js Outdated Show resolved Hide resolved
samples/scenarios.js Outdated Show resolved Hide resolved
jwcastillo and others added 2 commits January 16, 2023 06:20
Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com>
Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com>
@codebien
Copy link
Contributor

Hey @jwcastillo,
thanks for your contribution 🙇

@ppcano I assigned you as a reviewer so we have more opinions here

@codebien codebien requested a review from ppcano January 16, 2023 09:21
@ppcano
Copy link
Contributor

ppcano commented Jan 16, 2023

Nice job, @jwcastillo.

I doubt whether to include the Apdex metric or not. Neither Grafana pre-built dashboards nor k6 Cloud present the Apdex score by default. Initially, we aim for consistency across OSS and commercial dashboards. @dgzlopes, wdyt?

@dgzlopes
Copy link
Member

Yeah, lovely PR! Thanks for the work ❤️

I doubt whether to include the Apdex metric or not. Neither Grafana pre-built dashboards nor k6 Cloud present the Apdex score by default. Initially, we aim for consistency across OSS and commercial dashboards. @dgzlopes, wdyt?

I fully agree, it feels a bit out of place in this dashboard 👍

@jwcastillo
Copy link
Contributor Author

Ok I put it in a separate dashboard, like the custom metrics example

@javaducky javaducky self-requested a review January 17, 2023 20:15
@javaducky
Copy link
Contributor

Looks awesome!

Copy link
Contributor

@codebien codebien left a comment

Choose a reason for hiding this comment

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

@jwcastillo thanks.

I would prefer if we replace the image prometheus-dashboard-k6-test-result.png with the image we use for prometheus-dashboard-k6-test-result-performance.png. It is nice to have an overview of the dashboard but I don't think we need so many details.

Same for The board is structured into 4 sections section, I'm for removing it, instead for the Test List I think we should crop the image to something similar to:
Screenshot 2023-01-19 at 10-50-50 xk6-output-prometheus-remote_prometheus-dashboard-k6-test-runs png at bc6cbf46f5d7638ef60597fa506afb908f4b722a · grafana_xk6-output-prometheus-remote

README.md Outdated
Comment on lines 131 to 147
The board is structured into 4 sections

#### Apex Overview
#### Performance Overview

[<img src="./images/prometheus-dashboard-k6-test-result-performance.png" width="500"/>](./images/prometheus-dashboard-k6-test-result-performance.png)

#### HTTP

[<img src="./images/prometheus-dashboard-k6-test-result-http.png" width="500"/>](./images/prometheus-dashboard-k6-test-result-http.png)

#### Scenarios

[<img src="./images/prometheus-dashboard-k6-test-result-scenarios.png" width="500"/>](./images/prometheus-dashboard-k6-test-result-scenarios.png)

### Test list dashboard

[<img src="./images/prometheus-dashboard-k6-test-runs.png" width="500"/>](./images/prometheus-dashboard-k6-test-runs.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need these details in the README. The performance overview should be enough as the screenshot for the Test result dashboard.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok

@codebien
Copy link
Contributor

codebien commented Jan 19, 2023

I think we shouldn't document the dashboards here. It would be better if we update the official doc. I think in this repo we should only document stuff specifically for the extension, all the rest should stay on the k6-docs.

I would open a PR to drop all the current text of the README and structure a list of links plus the specific info for the extension. Similar to what @MattDodsonEnglish did for https://github.com/grafana/k6/blob/master/README.md.

@ppcano @javaducky WDYT?

@ppcano
Copy link
Contributor

ppcano commented Jan 19, 2023

@codebien If the dashboards are now ready, I suggest merging the PR and we'll update the readme and the docs.

Copy link
Contributor

@codebien codebien left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the effort @jwcastillo 🙇

@codebien codebien merged commit 55fe9ae into grafana:main Jan 19, 2023
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

5 participants