Skip to content

Commit

Permalink
Add aliases to http-instrumentation-tempo pages
Browse files Browse the repository at this point in the history
  • Loading branch information
heitortsergent committed Nov 8, 2024
1 parent dde5a2a commit acc25d7
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
aliases:
- ../k6-experimental/tracing/ # docs/k6/<K6_VERSION>/javascript-api/k6-experimental/tracing/
title: 'HTTP instrumentation for Tempo'
menuTitle: http-instrumentation-tempo
description: 'k6 Tempo instrumentation API'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
aliases:
- ../../k6-experimental/tracing/client/ # docs/k6/<K6_VERSION>/javascript-api/k6-experimental/tracing/client/
title: 'Client'
description: 'Client is a HTTP client attaching tracing information to its requests.'
weight: 02
Expand Down Expand Up @@ -82,6 +84,6 @@ The following table lists the `Client` methods which have an equivalent in the s

`Client` instances support being reconfigured using the following API:

| Method | Description |
| :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Method | Description |
| :-------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Client.configure(options)` | Reconfigures the tracing client instance with the provided [`Options`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/http-instrumentation-tempo/options) |
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
aliases:
- ../../k6-experimental/tracing/instrumenthttp/ # docs/k6/<K6_VERSION>/javascript-api/k6-experimental/tracing/instrumenthttp/
title: 'instrumentHTTP'
description: 'instrumentHTTP instruments the k6 http module with tracing capabilities.'
weight: 01
Expand All @@ -15,8 +17,8 @@ From that point forward, all requests made by the HTTP module from that point fo

## Parameters

| Name | Type | Description |
| :-------- | :--------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Type | Description |
| :-------- | :------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `options` | [`Options`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/http-instrumentation-tempo/options) | Configures the tracing behavior with the provided [`Options`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/jslib/http-instrumentation-tempo/options) object. |

## Example
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
---
aliases:
- ../../k6-experimental/tracing/options/ # docs/k6/<K6_VERSION>/javascript-api/k6-experimental/tracing/options/
title: 'Options'
description: 'Options allows to configure the tracing instrumentation behavior.'
weight: 03
Expand All @@ -10,7 +12,7 @@ Use the `Options` object to configure the tracing instrumentation behavior. It i

## Options

| Option name | Type | Default | Description |
| :----------- | :------- | :------ | :----------------------------------------------------------------------------- |
| `propagator` | `string` | `w3c` | The trace context propagation format. Currently supported: `w3c` and `jaeger`. |
| `sampling` | `number` | `1` | A number between 0 and 1 defining the sampling rate. 1 means sample always, 0 means never sample. |
| Option name | Type | Default | Description |
| :----------- | :------- | :------ | :------------------------------------------------------------------------------------------------ |
| `propagator` | `string` | `w3c` | The trace context propagation format. Currently supported: `w3c` and `jaeger`. |
| `sampling` | `number` | `1` | A number between 0 and 1 defining the sampling rate. 1 means sample always, 0 means never sample. |

0 comments on commit acc25d7

Please sign in to comment.