-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(trace mode): added trace mode and improved misc pages
- Loading branch information
1 parent
9e293f2
commit ea91af2
Showing
8 changed files
with
222 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| id: traces | ||
| title: Traces | ||
| description: Tracetest uses the concept of Traces to enable previewing ingested traces. While in trace mode you can view all traces your apps are exporting. You can select traces to test and start creating assertions right away! | ||
| keywords: | ||
| - tracetest | ||
| - trace-based testing | ||
| - observability | ||
| - distributed tracing | ||
| - testing | ||
| - traces | ||
| - tracing | ||
| image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg | ||
| --- | ||
|
|
||
| Tracetest uses the concept of Traces to enable previewing ingested traces. On the Traces screen you can view all traces your apps are exporting. You can select traces to test and start creating assertions right away! | ||
|
|
||
| :::note trace retention | ||
| Ingested traces will be deleted after 96 hours. | ||
| ::: | ||
|
|
||
| - [Tests](/concepts/tests) | ||
| - [Assertions](/concepts/assertions) | ||
|
|
||
|  | ||
|
|
||
| A trace allows you to: | ||
|
|
||
| - Preview spans in distributed traces your distributed system is exporting. | ||
| - Analyze traces and span attributes. | ||
| - Create tests from traces that are ingested in your Tracetest account via a trace ID. | ||
| - Create assertions for particular spans to verify the behavior of the system at every step of the request transaction. | ||
| - Create test triggers automatically based on span attributes and metadata. | ||
|
|
||
|  | ||
|
|
||
| A trace in Tracetest helps you get insight into what your system is doing. It will guide you to define trace-based assertions that validate the end-to-end behavior of a distributed system, going beyond just UI or API-level testing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| id: triggers | ||
| title: Triggers | ||
| description: Tracetest uses the concept of Tests to define how to trigger a test against your application, define assertions against its trace data, and automate its execution. Every time a Test is triggered it will create a Run. | ||
| keywords: | ||
| - tracetest | ||
| - trace-based testing | ||
| - observability | ||
| - distributed tracing | ||
| - testing | ||
| image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg | ||
| --- | ||
|
|
||
| Tracetest uses the concept of Triggers to define how to initiate a test run. | ||
|
|
||
| ## Native Triggers | ||
|
|
||
| Triggers define how Tracetest interacts with your application. | ||
|
|
||
| ### Web UI | ||
|
|
||
| - [HTTP Request - Create a basic HTTP request.](/web-ui/creating-tests-http) | ||
| - [GRPC Request - Test and debug your GRPC request.](/web-ui/creating-tests-gRPC) | ||
| - [Kafka - Test consumers with Kafka messages.](/web-ui/creating-tests-kafka) | ||
| - [Playwright Engine - Run Playwright tests natively in Tracetest.](/web-ui/creating-tests-playwright-engine) | ||
| - [GraphQL - Test and debug your GraphQL request.](/web-ui/creating-tests-graphql) | ||
| - [TraceID - Define your test via a TraceID.](/web-ui/creating-tests-traceid) | ||
|
|
||
|  | ||
|
|
||
| ### CLI | ||
|
|
||
| The attribute `type` defines which trigger method you are going to use to interact with your application. | ||
|
|
||
| ```yaml | ||
| trigger: | ||
| type: http|grpc|kafka|traceid|cypress|playwright|k6|artillery | ||
| ... | ||
| ``` | ||
|
|
||
| - [HTTP Request - Create a basic HTTP request.](/cli/creating-tests-http) | ||
| - [GRPC Request - Test and debug your GRPC request.](/cli/creating-tests-grpc) | ||
| - [Kafka - Test consumers with Kafka messages.](/cli/creating-tests-kafka) | ||
| - [Playwright Engine - Run Playwright tests natively in Tracetest.](/cli/creating-tests-playwright-engine) | ||
| - [GraphQL - Test and debug your GraphQL request.](/cli/creating-tests-graphql) | ||
| - [TraceID - Define your test via a TraceID.](/cli/creating-tests-traceid) | ||
|
|
||
| ## Integrations | ||
|
|
||
| Initiate test runs from triggers outside of Tracetest. | ||
|
|
||
| - [Cypress](/web-ui/creating-tests-cypress) | ||
| - [Playwright](/web-ui/creating-tests-playwright) | ||
| - [k6](/web-ui/creating-tests-k6) | ||
| - [Artillery](/web-ui/creating-tests-artillery) |
50 changes: 50 additions & 0 deletions
50
docs/docs/configuration/connecting-to-data-stores/otlp-ingestion-endpoint.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| id: otlp-ingestion-endpoint | ||
| title: OTLP Ingestion Endpoint | ||
| description: Configure the Tracetest Agent to ingest traces and sync them with Tracetest. | ||
| keywords: | ||
| - tracetest | ||
| - trace-based testing | ||
| - observability | ||
| - distributed tracing | ||
| - testing | ||
| image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg | ||
| --- | ||
|
|
||
| Tracetest Agent receives trace data on port `4317` and `4318`. The OTLP endpoint might look like: | ||
|
|
||
| ```bash | ||
| http://tracetest-agent:4317 | ||
| ``` | ||
|
|
||
| :::tip | ||
| Examples of configuring Tracetest can be found in the [`examples` folder of the Tracetest GitHub repo](https://github.com/kubeshop/tracetest/tree/main/examples). | ||
| ::: | ||
|
|
||
| ## Connect Tracetest to Ingest OpenTelemetry Traces with the Web UI | ||
|
|
||
| In the Web UI, (1) open Settings, and, on the (2) Trace Ingestion tab, select (3) OpenTelemetry. | ||
|
|
||
|  | ||
|
|
||
| ## Connect Tracetest to OpenTelemetry Collector with the CLI | ||
|
|
||
| Or, if you prefer using the CLI, you can use this file config. | ||
|
|
||
| ```yaml | ||
| type: DataStore | ||
| spec: | ||
| name: Opentelemetry Collector pipeline | ||
| type: otlp | ||
| default: true | ||
| ``` | ||
| Proceed to run this command in the terminal, and specify the file above. | ||
| ```bash | ||
| tracetest apply datastore -f my/data-store/file/location.yaml | ||
| ``` | ||
|
|
||
| :::tip | ||
| To learn more, [read the recipe on running a sample app with OpenTelemetry Collector and Tracetest](/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store). | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| id: trace-mode | ||
| title: Trace Mode | ||
| description: Trace Mode is provided in Tracetest to help preview all ingested traces to simplify in pinpointing traces to speed up creating tests. | ||
| keywords: | ||
| - tracetest | ||
| - trace-based testing | ||
| - observability | ||
| - distributed tracing | ||
| - testing | ||
| image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg | ||
| --- | ||
|
|
||
| Trace Mode is provided in Tracetest to help preview all ingested traces. This simplifies pinpointing which spans to use for creating tests. | ||
|
|
||
| :::tip | ||
| [Read more about Trace Mode concepts here.](/concepts/traces) | ||
| ::: | ||
|
|
||
| ## View Traces | ||
|
|
||
| 1. Start [Tracetest Agent](/configuration/agent). | ||
| 2. Configure [Trace Ingestion](/configuration/connecting-to-data-stores/otlp-ingestion-endpoint). | ||
| 3. Send traces to Tracetest Agent. | ||
| 4. View traces in Tracetest. | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters