Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Trace Mode Doc #4042

Merged
merged 1 commit into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/docs/img/delete-previous-agent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/img/trace-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/img/trace-ingestion-save.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/img/trace-ingestion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/img/traces-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions docs/docs/web-ui/trace-mode.md
Original file line number Diff line number Diff line change
@@ -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=<your-agent-api-key>
TRACETEST_ENVIRONMENT_ID=<your-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)

5 changes: 5 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
6 changes: 6 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading