xk6-output-prometheus-remote

What's Changed

• Update k6 to v0.47.0 by @codebien in https://github.com/grafana/xk6-output-prometheus-remote/pull/157
• Fix 32-bit build by @mem in https://github.com/grafana/xk6-output-prometheus-remote/pull/158
• Fix Peak RPS calculation, shared tooltip and fix VU display in the Performance Overview by @Sea-you in https://github.com/grafana/xk6-output-prometheus-remote/pull/165
• Minor linter fixes by @olegbespalov in https://github.com/grafana/xk6-output-prometheus-remote/pull/166
• Change to using sobek instead of goja by @mstoykov in https://github.com/grafana/xk6-output-prometheus-remote/pull/167

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.3.1...v0.4.0

It fixes a bug of the parsing operation of the Beaer Token option in https://github.com/grafana/xk6-output-prometheus-remote/pull/155

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.3.0...v0.3.1

What's Changed

• Bump k6 version to the latest master version https://github.com/grafana/xk6-output-prometheus-remote/pull/144
• New format for custom HTTP header options provided by environment variables https://github.com/grafana/xk6-output-prometheus-remote/pull/147
• Support Bearer Token for client authentication https://github.com/grafana/xk6-output-prometheus-remote/pull/145
• The remote protocol uses now the klauspost/compress/snappy library as the implementation for Snappy compression https://github.com/grafana/xk6-output-prometheus-remote/pull/146
• Support TLS certificates for client authentication https://github.com/grafana/xk6-output-prometheus-remote/pull/143, thanks @raoel for the contribution!

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.2.3...v0.3.0

What's Changed

• Reverted Afero dependency update to keep it aligned with the k6 used version in https://github.com/grafana/xk6-output-prometheus-remote/pull/135

What's Changed

• Bumped docker-compose services' versions in https://github.com/grafana/xk6-output-prometheus-remote/pull/128
• Updated the k6 dependency to the latest master version in https://github.com/grafana/xk6-output-prometheus-remote/pull/133
• Pinned the builder stage to alpine 3.18, thanks @arukiidou in https://github.com/grafana/xk6-output-prometheus-remote/pull/126
• Migrate to Buf remote packages thanks @pkwarren in https://github.com/grafana/xk6-output-prometheus-remote/pull/134 and https://github.com/grafana/xk6-output-prometheus-remote/pull/130

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.2.1...v0.2.2

What's Changed

• k6 dependency updated
• Fixed the Prometheus variable for the Grafana dashboard's data source in https://github.com/grafana/xk6-output-prometheus-remote/pull/114, thanks @7olstoy!
• Grafana dashboard improvements in https://github.com/grafana/xk6-output-prometheus-remote/pull/115, thanks @jwcastillo!

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.2.0...v0.2.1

What's Changed

• dashboard: add code status rate and apdex, improvement checks, update… by @jwcastillo in https://github.com/grafana/xk6-output-prometheus-remote/pull/98
• Link the official doc by @codebien in https://github.com/grafana/xk6-output-prometheus-remote/pull/99
• dashboard: Various improvements by @jwcastillo in https://github.com/grafana/xk6-output-prometheus-remote/pull/102

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.1.0...v0.2.0

What's Changed

• [Bugfix] Not map tags with empty fields as labels in https://github.com/grafana/xk6-output-prometheus-remote/pull/92 thanks @afajl

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.9...v0.1.0

What's Changed

Stale marker option in https://github.com/grafana/xk6-output-prometheus-remote/pull/86

[Breaking change] The stale marker process now has an option staleMarkers and it is set to false by default. In the case of Prometheus, the time series added will be seen as active for the next 5 minutes after the last sample, when they will be automatically marked as stale. If the option is true, the time series will be marked as stale as soon as the test is completed.

K6_PROMETHEUS_RW_STALE_MARKERS is the environment variable to set the option.

Do not skip the TLS validation in https://github.com/grafana/xk6-output-prometheus-remote/pull/87

[Bugfix] By default, the TLS client validation is not skipped anymore.

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.8...v0.0.9

What's Changed

Renamed to xk6-prometheus-rw https://github.com/grafana/xk6-output-prometheus-remote/pull/79

The Output's registered name has been changed to prometheus-rw, it is consistent with the name that will be used for the experimental version builtin in k6.

./k6 run -o xk6-prometheus-rw script.js

Environment variables prefix

The environment variable prefix has been changed to K6_PROMETHEUS_RW_ to be consistent with the name of the Output.

Remote Write endpoint URL

The environment variable for setting the Remote Write URL has been renamed to K6_PROMETHEUS_RW_SERVER_URL for better clarity.

K6_PROMETHEUS_RW_SERVER_URL=http://localhost:9090/api/v1/write ./k6 run -o output-prometheus-remote script.js

Time series stale marker https://github.com/grafana/xk6-output-prometheus-remote/pull/73

The Output marks all the seen time series as stale before exiting, the time series will not be visible anymore as active for a longer time unexpectedly.

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.7...v0.0.8

What's Changed

Experimental Native Histogram - https://github.com/grafana/xk6-output-prometheus-remote/pull/57

Prometheus from v2.40.0 adds as an experimental feature a new histogram metric type called Native Histogram supporting dynamic buckets. It can be enabled by the feature flag --enable-feature=native-histograms.

Setting the K6_PROMETHEUS_TREND_AS_NATIVE_HISTOGRAM=true environment variable enables the support for flushing k6 Trend metrics as Native Histograms.

The Grafana dashboard in grafana folder has been updated for supporting the Native Histogram time series. Thanks @jwcastillo.

Trend stats changes

The Trend classic mapping with Counters / Gauges has been updated. The specific stats to generate from each Trend metric are now configurable via the K6_PROMETHEUS_TREND_STATS environment variable. It follows the same syntax already used by the k6's Summary Trend Stats option. The default set includes only the 99th percentile.

Naming convention

When possible the mapping applies the best practices as suggested by Prometheus:

• Counter-type metrics are mapped including the _total suffix in the name.
• Trend-type metrics when the value type is defined then the mapping includes the specific base unit for Time (seconds) or Data (bytes) values. e.g. k6_http_req_duration_seconds (native histogram) / k6_http_req_duration_seconds_p99 (stats).
• Rate-type metrics are mapped with the _rate suffix for better clarity.

Removed setting options directly from the CLI

Setting the Output's options directly from the CLI defining the text string is not available anymore. We may re-introduce this functionality in the future based on a batter and shared protocol between all the k6's Outputs.

New Contributors

• @arukiidou made their first contribution https://github.com/grafana/xk6-output-prometheus-remote/pull/63

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.6...v0.0.7

What's Changed

• Fixed sorting labels https://github.com/grafana/xk6-output-prometheus-remote/pull/58
• Fixed the expected response's status code https://github.com/grafana/xk6-output-prometheus-remote/pull/60
• Fixed Username option when passed as an environment variable or argument https://github.com/grafana/xk6-output-prometheus-remote/pull/61

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.5...v0.0.6

What's Changed

• Moved to AGPLv3 license in https://github.com/grafana/xk6-output-prometheus-remote/pull/50
• Config changes in https://github.com/grafana/xk6-output-prometheus-remote/pull/48
• Removed the prometheus/prometheus library dependency in https://github.com/grafana/xk6-output-prometheus-remote/pull/49
• Migrate to k6 v0.41 in https://github.com/grafana/xk6-output-prometheus-remote/pull/55

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.4...v0.0.5

Configuration

In #48 we did several changes to the configuration's options.

• K6_PROMETHEUS_FLUSH_PERIOD has been renamed to K6_PROMETHEUS_PUSH_INTERVAL to align with the same name used by timescaledb, influxdb and statsd outputs.
• K6_PROMETHEUS_USER has been renamed to K6_PROMETHEUS_USERNAME to align with the same name used by influxdb output.
• CACert option has been removed, use the common SSL_CERT_FILE and SSL_CERT_DIR environment variables if overriding the system's default locations is needed.
• KeepTags, KeepNameTag, KeepUrlTag options have been removed in favour of the k6's way of filtering tags by overriding the default systemTags. An advanced version will be implemented in the future and plans are tracked at https://github.com/grafana/xk6-output-prometheus-remote/issues/5, feel free to let know your requirements there.
• Mapping option has been removed, at the moment, the Output doesn't support different mappings.

The timeout's default value for HTTP requests to the Prometheus remote write endpoint has been reduced from 1 minute to 5 seconds. If a different value is needed share more ideas at https://github.com/grafana/xk6-output-prometheus-remote/issues/52.

Usage

v0.0.5 requires k6 v0.41.0 for being sure to use the correct version it can be explicitly set in the xk6 build command:

xk6 build v0.41.0 --with github.com/grafana/[email protected]

What's Changed

• Aggregating and flushing by time series instead of global metrics in https://github.com/grafana/xk6-output-prometheus-remote/pull/38
• Upgraded k6 dependency to v0.40.0 in https://github.com/grafana/xk6-output-prometheus-remote/pull/42
• Upgraded Go to 1.19 in https://github.com/grafana/xk6-output-prometheus-remote/pull/43 https://github.com/grafana/xk6-output-prometheus-remote/pull/45

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.3...v0.0.4

What's Changed

• New dashboards by @jwcastillo in https://github.com/grafana/xk6-output-prometheus-remote/pull/29
• Send the trend count as a metric by @robholland in https://github.com/grafana/xk6-output-prometheus-remote/pull/31
• Send trend sum as a metric by @pablochacin in https://github.com/grafana/xk6-output-prometheus-remote/pull/34

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.2...v0.0.3

What's Changed

• docker-compose: Fixed the Prometheus data source in https://github.com/grafana/xk6-output-prometheus-remote/pull/22
• Fixed a data race generated from the k6 metric mapping in https://github.com/grafana/xk6-output-prometheus-remote/pull/23

Full Changelog: https://github.com/grafana/xk6-output-prometheus-remote/compare/v0.0.1...v0.0.2

Simply starting to version going forward.