diff --git a/docs/docs/img/delete-previous-agent.png b/docs/docs/img/delete-previous-agent.png new file mode 100644 index 0000000000..91886af899 Binary files /dev/null and b/docs/docs/img/delete-previous-agent.png differ diff --git a/docs/docs/img/trace-details.png b/docs/docs/img/trace-details.png new file mode 100644 index 0000000000..e59f1d63a3 Binary files /dev/null and b/docs/docs/img/trace-details.png differ diff --git a/docs/docs/img/trace-ingestion-save.png b/docs/docs/img/trace-ingestion-save.png new file mode 100644 index 0000000000..80e7accaf6 Binary files /dev/null and b/docs/docs/img/trace-ingestion-save.png differ diff --git a/docs/docs/img/trace-ingestion.png b/docs/docs/img/trace-ingestion.png new file mode 100644 index 0000000000..2cb2db070b Binary files /dev/null and b/docs/docs/img/trace-ingestion.png differ diff --git a/docs/docs/img/traces-list.png b/docs/docs/img/traces-list.png new file mode 100644 index 0000000000..9f85f22710 Binary files /dev/null and b/docs/docs/img/traces-list.png differ diff --git a/docs/docs/web-ui/trace-mode.md b/docs/docs/web-ui/trace-mode.md new file mode 100644 index 0000000000..3bfc5fe283 --- /dev/null +++ b/docs/docs/web-ui/trace-mode.md @@ -0,0 +1,50 @@ +# Trace Mode + +Trace Mode enables you to verify trace ingestion is configured correctly, and is also as a starting point to create trace-based tests. + +You can use it to: +- View traces coming in to your Tracetest account. +- Create tests from certain trace spans. Tracetest figures out how to help you trigger tests based on span attributes and metadata. +- Create tests from trace IDs. + +:::note +Traces will be deleted after 4 days. +::: + +The steps to use Tracetest Trace Mode are: + +**1.** Pull the latest version of the Pokeshop repo master branch [here](https://github.com/kubeshop/pokeshop). + +**2.** Make sure Docker is running. + +**3.** In the Docker Desktop, search for and make sure to delete any previous agent image. + +![Delete Previous Agent](../img/delete-previous-agent.png) + + +**4.** Create the .env file in the pokeshop root folder from the template and add +`POKESHOP_DEMO_URL=http://localhost:8081 +TRACETEST_AGENT_API_KEY= +TRACETEST_ENVIRONMENT_ID= +TRACETEST_TRACE_MODE=true`. + +The agent API key and Environment ID can be found [here](https://app.tracetest.io/retrieve-token). + +**5.** From the `pokeshop` root folder run `docker compose -f docker-compose.yml -f docker-compose.e2e.yml up -d`. + +**6.** From the Tracetest app, in **Settings**, go to the **Trace Ingestion** configuration tab and select **Open Telemetry**. + +![Trace Ingestion](../img/trace-ingestion.png) + +You will see the **Open Telemetry** details and click **Save**: + +![Trace Ingestion Save](../img/trace-ingestion-save.png) + +**7.** Open your environment dashboard and look at the Traces' landing page. + +![Trace Landing Page](../img/traces-list.png) + +**8.** Play around with the Pokeshop UI at http://localhost:8081. You'll see traces appearing in the landing page. + +![Trace Details](../img/trace-details.png) + diff --git a/docs/sidebars.js b/docs/sidebars.js index 7d729ac299..f760a732d3 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -1004,6 +1004,11 @@ const sidebars = { id: "web-ui/creating-data-stores", label: "Configuring Trace Ingestion", }, + { + type: "doc", + id: "web-ui/trace-mode", + label: "Configuring Traces", + }, { type: "category", label: "Configuring Tests", diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000000..8af9061a54 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,6 @@ +{ + "name": "tracetest", + "lockfileVersion": 3, + "requires": true, + "packages": {} +}