Skip to content

Commit 9fefc0a

Browse files
Add deprecation warning for statsd output (#1359)
* Add deprecation warning for statsd output * Update en guides for using statsd extension * Update installation-instructions.view.js * Update statsd output command on es guides * Update es results output code snippet * Update Netdata broken links
1 parent 891530e commit 9fefc0a

File tree

11 files changed

+99
-27
lines changed

11 files changed

+99
-27
lines changed

src/components/shared/installation-instructions/installation-instructions.view.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const InstallationInstructions = ({ extensionUrl }) => (
1919
<Blockquote>
2020
<p>
2121
To learn more about how to build custom k6 versions, check out{' '}
22-
<a href="https://github.com/grafana/xk6">xk6</a>
22+
<a href="https://github.com/grafana/xk6">xk6</a>.
2323
</p>
2424
</Blockquote>
2525
</>

src/data/markdown/translated-guides/en/04 Results output/200 Real-time/00 Amazon CloudWatch.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,26 @@ title: 'Amazon CloudWatch'
33
excerpt: 'You can send k6 results output to Amazon CloudWatch and later visualize them.'
44
---
55

6-
k6 can send metrics data to [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/) through the [CloudWatch Agent](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html), which is effectively a StatsD integration. These metrics can then be visualized in dashboards.
6+
<Blockquote mod="warning" title="">
77

8-
This guide covers running the CloudWatch integration and visualizing the results:
8+
The built-in StatsD output has been deprecated on k6 v0.47.0. You can continue to use this feature by using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd), and this guide has been updated to include instructions for how to use it.
9+
10+
For more information on the reason behind this change, you can follow [this issue](https://github.com/grafana/k6/issues/2982) in the k6 repository.
11+
12+
</Blockquote>
13+
14+
k6 can send metrics data to [Amazon CloudWatch](https://aws.amazon.com/cloudwatch/) through the [CloudWatch Agent](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html) by using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd). These metrics can then be visualized in dashboards.
15+
16+
This guide covers how to:
917

1018
- Run the CloudWatch agent
1119
- Run the k6 test
1220
- Visualize k6 metrics in Amazon CloudWatch
1321

22+
## Before you begin
23+
24+
To use the StatsD output option, you have to build a k6 binary using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd). For more details, refer to [StatsD](/results-output/real-time/statsd).
25+
1426
## Run the CloudWatch agent
1527

1628
We presume that you already have a machine that supports both running k6 and CloudWatch agent, which either runs a flavor of GNU/Linux or Windows. Just go ahead and [download](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/download-cloudwatch-agent-commandline.html) the suitable CloudWatch agent version for your operating system.
@@ -60,18 +72,20 @@ We presume that you already have a machine that supports both running k6 and Clo
6072

6173
## Run the k6 test
6274

63-
Once the agent is running, [install](/get-started/installation) k6 and [run](/get-started/running-k6) the test, so that the metrics gets sent to the agent with the following command:
75+
Once the agent is running, you can run your test with:
6476

6577
<CodeGroup labels={[]}>
6678

6779

6880
```bash
69-
$ K6_STATSD_ENABLE_TAGS=true k6 run --out statsd script.js
81+
$ K6_STATSD_ENABLE_TAGS=true k6 run --out output-statsd script.js
7082
```
7183

7284
</CodeGroup>
7385

74-
Please look at [StatsD](/results-output/real-time/statsd) output page for configuration options.
86+
Make sure you're using the k6 binary you built with the xk6-output-statsd extension.
87+
88+
You can look at the [StatsD](/results-output/real-time/statsd) output page for configuration options.
7589

7690
## Visualize k6 metrics in Amazon CloudWatch
7791

src/data/markdown/translated-guides/en/04 Results output/200 Real-time/00 DataDog.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,26 @@ title: 'Datadog'
33
excerpt: 'Send k6 output to Datadog to visualize load test results and correlate performance testing metrics in Datadog.'
44
---
55

6-
> ⚠️ &nbsp; For k6 Cloud tests, follow the [k6 Cloud instructions](/cloud/integrations/cloud-apm/datadog).
6+
<Blockquote mod="warning" title="">
7+
8+
The built-in StatsD output has been deprecated on k6 v0.47.0. You can continue to use this feature by using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd), and this guide has been updated to include instructions for how to use it.
9+
10+
For more information on the reason behind this change, you can follow [this issue](https://github.com/grafana/k6/issues/2982) in the k6 repository.
11+
12+
</Blockquote>
713

814
k6 can send metrics to [Datadog](https://www.datadoghq.com/). That allows visualizing and correlating performance testing metrics with other monitored metrics in Datadog.
915

10-
This article outlines the instructions of the Datadog integration:
16+
This guide covers how to:
1117

1218
- Run the Datadog Agent
1319
- Run the k6 test
1420
- Visualize in Datadog
1521

22+
## Before you begin
23+
24+
To use the StatsD output option, you have to build a k6 binary using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd). For more details, refer to [StatsD](/results-output/real-time/statsd).
25+
1626
## Run the Datadog Agent
1727

1828
To get k6 metrics into Datadog, k6 sends metrics through the Datadog Agent, which collects, aggregates, and forwards the metrics to the Datadog platform.
@@ -58,12 +68,14 @@ Once the Datadog Agent service is running, run the k6 test and send the metrics
5868
<CodeGroup labels={[""]}>
5969

6070
```bash
61-
$ K6_STATSD_ENABLE_TAGS=true k6 run --out statsd script.js
71+
$ K6_STATSD_ENABLE_TAGS=true k6 run --out output-statsd script.js
6272
```
6373

6474
</CodeGroup>
6575

66-
Please look at the [StatsD](/results-output/real-time/statsd) output page for configuration options.
76+
Make sure you're using the k6 binary you built with the xk6-output-statsd extension.
77+
78+
You can look at the [StatsD](/results-output/real-time/statsd) output page for configuration options.
6779

6880
## Visualize in Datadog
6981

src/data/markdown/translated-guides/en/04 Results output/200 Real-time/00 Netdata.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,23 @@ title: 'Netdata'
33
excerpt: 'You can send k6 output to Netdata. With this integration, visualize test results with zero configuration, in seconds'
44
---
55

6+
<Blockquote mod="warning" title="">
7+
8+
The built-in StatsD output has been deprecated on k6 v0.47.0. You can continue to use this feature by using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd), and this guide has been updated to include instructions for how to use it.
9+
10+
For more information on the reason behind this change, you can follow [this issue](https://github.com/grafana/k6/issues/2982) in the k6 repository.
11+
12+
</Blockquote>
13+
614
k6 can send performance testing metrics to [Netdata](https://netdata.cloud). This enables the user to start monitoring their k6 experiments right away, as Netdata is a monitoring tool with:
7-
- auto-configuration and auto-detection of data sources
8-
- automatic organization of metrics into **meaningful** charts and visualization
9-
- per-second metric granularity
15+
16+
- Auto-configuration and auto-detection of data sources
17+
- Automatic organization of metrics into **meaningful** charts and visualization
18+
- Per-second metric granularity
19+
20+
## Before you begin
21+
22+
To use the StatsD output option, you have to build a k6 binary using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd). For more details, refer to [StatsD](/results-output/real-time/statsd).
1023

1124
## Run Netdata
1225

@@ -19,21 +32,24 @@ Alternatively, you can read more about installing and running Netdata in their [
1932

2033
## Setup Netdata for K6
2134

22-
Netdata runs a fully functional [StatsD](https://learn.netdata.cloud/docs/agent/collectors/statsd.plugin) server by default and we have included a default configuration file for k6 metrics.
35+
Netdata runs a fully functional [StatsD](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md) server by default and we have included a default configuration file for k6 metrics.
2336

2437
## Run the k6 test
2538

2639
```bash
27-
k6 run --out statsd script.js
40+
k6 run --out output-statsd script.js
2841
```
2942

43+
Make sure you're using the k6 binary you built with the xk6-output-statsd extension.
44+
3045
**Caveat**: By default, Netdata binds the StatsD server to `localhost`. That means that if Netdata and k6 are in different hosts, you will need to edit the configuration file of Netdata.
31-
1. Visit [StatsD documentation](https://learn.netdata.cloud/docs/agent/collectors/statsd.plugin) for a reference on the configuration options. We are interested in `#bind to` option.
46+
47+
1. Visit the [StatsD documentation](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/README.md) for a reference on the configuration options. We are interested in the `#bind to` option.
3248
2. Use `sudo ./edit-config netdata.conf` from inside the directory where Netdata stores its configuration files (e.g `/etc/netdata/`) and add `bind to=udp:0.0.0.0:8125`.
3349

3450
## Visualize in Netdata
3551

36-
Netdata will automatically create charts for your application, as illustrated in the [documentation](https://learn.netdata.cloud/docs/agent/collectors/statsd.plugin/k6).
52+
Netdata will automatically create charts for your application, as illustrated in the [documentation](https://github.com/netdata/netdata/blob/master/collectors/statsd.plugin/k6.md).
3753

3854
Simply head over to `localhost:19999` (assuming that you are running Netdata on the same machine) and find the k6 section. If you had opened Netdata before running the experiment, you will need to refresh the dashboard page.
3955

src/data/markdown/translated-guides/en/04 Results output/200 Real-time/00 NewRelic.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@ title: 'New Relic'
33
excerpt: 'You can send k6 output to New Relic. With this integration visualize load test results and correlate them your New Relic telemetry data, create and share reports, and alert on k6 telemetry.'
44
---
55

6-
> ⚠️ &nbsp; For k6 Cloud tests, follow the [k6 Cloud instructions](/cloud/integrations/cloud-apm/new-relic).
6+
<Blockquote mod="warning" title="">
7+
8+
The built-in StatsD output has been deprecated on k6 v0.47.0. You can continue to use this feature by using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd), and this guide has been updated to include instructions for how to use it.
9+
10+
For more information on the reason behind this change, you can follow [this issue](https://github.com/grafana/k6/issues/2982) in the k6 repository.
11+
12+
</Blockquote>
713

814
k6 can send telemetry data to [New Relic](https://newrelic.com/) through the New Relic [StatsD integration](https://docs.newrelic.com/docs/integrations/host-integrations/host-integrations-list/statsd-monitoring-integration-version-2). Within New Relic you can find your k6 performance data alongside your real users data and server side performance. This data can be visualized in dashboards and shared with others, used to compare load impact with system performance, and alert on metrics too.
915

@@ -13,6 +19,10 @@ This guide covers running the New Relic integration:
1319
- Run the k6 test
1420
- Visualize k6 telemetry in New Relic
1521

22+
## Before you begin
23+
24+
To use the StatsD output option, you have to build a k6 binary using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd). For more details, refer to [StatsD](/results-output/real-time/statsd).
25+
1626
## Run the New Relic StatsD integration
1727

1828
To get k6 metrics into New Relic, k6 sends metrics to the New Relic StatsD integration which will take care of collecting, aggregate, format and send the telemetry to the New Relic Telemetry Data Platform. You can run this with or without a New Relic agent.
@@ -66,12 +76,14 @@ Once the integration is running, run the k6 test and send the metrics to the int
6676
<CodeGroup labels={[""]}>
6777

6878
```bash
69-
$ K6_STATSD_ENABLE_TAGS=true k6 run --out statsd script.js
79+
$ K6_STATSD_ENABLE_TAGS=true k6 run --out output-statsd script.js
7080
```
7181

7282
</CodeGroup>
7383

74-
Please look at the [StatsD](/results-output/real-time/statsd) output page for configuration options.
84+
Make sure you're using the k6 binary you built with the xk6-output-statsd extension.
85+
86+
You can look at the [StatsD](/results-output/real-time/statsd) output page for configuration options.
7587

7688
## Visualisation in New Relic
7789

src/data/markdown/translated-guides/en/04 Results output/200 Real-time/00 StatsD.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,28 @@ title: 'StatsD'
33
excerpt: 'k6 has a built-in output to a StatsD service.'
44
---
55

6-
k6 can also push the metrics to a [StatsD](https://github.com/statsd/statsd) service like:
6+
<Blockquote mod="warning" title="">
7+
8+
The built-in StatsD output has been deprecated on k6 v0.47.0. You can continue to use this feature by using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd), and this guide has been updated to include instructions for how to use it.
9+
10+
For more information on the reason behind this change, you can follow [this issue](https://github.com/grafana/k6/issues/2982) in the k6 repository.
11+
12+
</Blockquote>
13+
14+
k6 can push test metrics to a [StatsD](https://github.com/statsd/statsd) service by using the [xk6-output-statsd extension](https://github.com/LeonAdato/xk6-output-statsd).
15+
16+
## Build the k6 version
17+
18+
<InstallationInstructions extensionUrl="github.com/grafana/xk6-output-statsd"/>
19+
20+
## Run the k6 test
21+
22+
Using the k6 binary you built in the previous step, you can use the `--out output-statsd` option when running your tests to use this extension:
723

824
<CodeGroup labels={["StatsD"]}>
925

1026
```bash
11-
$ k6 run --out statsd script.js
27+
$ ./k6 run --out output-statsd script.js
1228
```
1329

1430
</CodeGroup>

src/data/markdown/translated-guides/es/01 Get started/04 Results Output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ k6 puede enviar datos de resultados más granulares a diferentes salidas para in
103103
<CodeGroup labels={[]}>
104104

105105
```bash
106-
$ k6 run --out statsd script.js
106+
$ k6 run \
107+
--out json=test.json \
108+
--out influxdb=http://localhost:8086/k6
107109
```
108110

109111
</CodeGroup>

src/data/markdown/translated-guides/es/04 Results visualization/01 Amazon CloudWatch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Suponemos que ya tiene una máquina que soporta tanto la ejecución de k6 como d
6464
Una vez que el agente esté funcionando correctamente, [instale](/es/empezando/instalacion/) k6 y [ejecute](/es/empezando/ejecucion-de-k6/) la prueba, para que las métricas sean enviadas al agente mediante el siguiente comando:
6565

6666
```bash
67-
$ k6 run --out statsd script.js
67+
$ k6 run --out output-statsd script.js
6868
```
6969

7070
Las siguientes opciones pueden ser configuradas como variables de entorno, dependiendo de la configuración del agente:

src/data/markdown/translated-guides/es/04 Results visualization/08 Netdata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Netdata runs a fully functional [StatsD](https://learn.netdata.cloud/docs/agent/
2424
## Run the k6 test
2525

2626
```bash
27-
k6 run --out statsd script.js
27+
k6 run --out output-statsd script.js
2828
```
2929

3030
**Caveat**: By default, Netdata binds the StatsD server to `localhost`. That means that if Netdata and K6 are in different hosts, you will need to edit the configuration file of Netdata.

src/data/markdown/translated-guides/es/04 Results visualization/09 NewRelic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Una vez que la integración esté lista, ejecute la prueba con k6 y envíe las m
5252
<CodeGroup labels={[""]}>
5353

5454
```bash
55-
$ k6 run --out statsd script.js
55+
$ k6 run --out output-statsd script.js
5656
```
5757

5858
</CodeGroup>

0 commit comments

Comments
 (0)