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 that the summary export threshold is unintuitive #30

Closed
mstoykov opened this issue Jun 10, 2020 · 1 comment · Fixed by #212
Closed

Document that the summary export threshold is unintuitive #30

mstoykov opened this issue Jun 10, 2020 · 1 comment · Fixed by #212
Labels
Area: OSS Content Improvements or additions to community/oss documentation Priority: High

Comments

@mstoykov
Copy link
Contributor

When the summary export was written no one noticed that the boolean used to say whether a threshold has passed or not is true when it failed and false when it has passed, which confusing to users.

I think this should be documented better and we should have an example of a threshold

links:
original PR
community forum link
k6 issue

@na--
Copy link
Member

na-- commented Jan 4, 2021

This is somewhat connected to grafana/k6#1768 - that PR will preserve the current --summary-export format as it is, for backwards compatibility, but the data format we will pass to handleSummary() will be saner. As an example:

{
    "metrics": {
        "http_req_duration": {
            "type": "trend",
            "contains": "time",
            "values": {
                "p(80)": 277.99444800000003,
                "p(99.99)": 408.53503457669984,
                "avg": 202.9503869583333,
                "min": 132.286877,
                "med": 152.79688099999998,
                "p(70)": 271.7887037,
                "count": 120,
                "max": 408.674962,
                "p(90)": 280.83382650000004,
                "p(95)": 339.6004894,
                "p(99)": 395.77117560000005
            },
            "thresholds": {
                "p(95)<500": {
                    "ok": true
                }
            }
        },
    }
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OSS Content Improvements or additions to community/oss documentation Priority: High
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants