Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Julianne Fermi <[email protected]>
  • Loading branch information
Adnan Rahić and jfermi authored Sep 26, 2024
1 parent 0ea5d27 commit 941f309
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions docs/docs/getting-started/automate-test-runs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can define any number of tests to run on a schedule as part of a Synthetic M

## Schedule

Use a cronjob syntax or the Web UI dropdown to configure the schedule when the Synthetic Monitor will run.
Use a CronJob syntax or the Web UI dropdown to configure the schedule when the Synthetic Monitor will run.

## List of Alerts

Expand All @@ -56,7 +56,7 @@ You can define any number of webhooks to send alerts to. This enables integratin

## Create Synthetic Monitors Programatically in YAML

Using the test you added assertions to in the previous section, you can refernce it in the resource defintion for a Synthetic Monitor.
Using the test you added assertions to in the previous section, you can reference it in the resource definition for a Synthetic Monitor.

```yaml
type: Monitor
Expand Down Expand Up @@ -84,8 +84,8 @@ spec:
### The Synthetic Monitor You Defined
1. Runs the `import-pokemon.yaml` test.
2. It has a schedule of every 5 minutes.
3. It will send a webhook alert to Slack when the test fails.
2. Has a schedule of every 5 minutes.
3. Sends a webhook alert to Slack when the test fails.

## Create Synthetic Monitors Visually with the Web UI

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/getting-started/configure-trace-ingestion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs';

[Tracetest Agent](/concepts/agent) runs alongside your apps, in the same environment/network, to do two things:

1. Run tests against your apps
2. Ingest traces from your apps
1. Run tests against your apps.
2. Ingest traces from your apps.

This page explains (2), how to ingest traces into Tracetest Agent to enable trace-based testing.

Expand Down Expand Up @@ -96,8 +96,8 @@ Add Tracetest Agent to the same network and use service name mapping. *Example:

You can reach services running on your local machine using:

- Linux (docker version < 20.10.0): `172.17.0.1:8080`
- MacOS (docker version >= 18.03) and Linux (docker version >= 20.10.0): `host.docker.internal:8080`
- Linux (Docker version < 20.10.0): `172.17.0.1:8080`
- MacOS (Docker version >= 18.03) and Linux (Docker version >= 20.10.0): `host.docker.internal:8080`
:::

</TabItem>
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/getting-started/create-assertions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,9 @@ This opens the assertions engine.
4. Tracetest **DOES NOT** care about how many services were called internally, or which languages your services are written in, or what database you're using. Tracetest **only cares about the distributed trace data** you expose to use as assertions.
5. Tracetest can validate that things that **DID** or **DID NOT** happen, with just 3 lines of YAML!

## How Selectors Work?
## How Do Selectors Work?

**Selectors** works in a similar way as CSS selectors. You can select spans by matching thier attributes. Attributes can be generic, like span type, duration, or be defined by your apps.
**Selectors** works in a similar way as CSS selectors. You can select spans by matching their attributes. Attributes can be generic, like span type, duration, or be defined by your apps.

Here are some examples:

Expand All @@ -210,7 +210,7 @@ Here are some examples:

Check the full [selector docs, here](/concepts/selectors).

## How Assertions Work?
## How Do Assertions Work?

Assertions are the checks you can apply to the values of all the spans matched by the related selector.

Expand All @@ -230,7 +230,7 @@ Here are some examples:

Check the full [assertions docs, here](/concepts/assertions).

## How Expressions Work?
## How Do Expressions Work?

Tracetest allows you to add expressions when writing test specs.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/getting-started/create-response-based-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs';

To create a test you define a `trigger`. A trigger is an action that executes an action against your system. The most basic trigger is an HTTP requests, but we support several trigger types.
To create a test, you define a `trigger`. A trigger is an action that executes an action against your system. The most basic trigger is an HTTP requests, but we support several trigger types.

1. Playwright
2. HTTP
Expand Down Expand Up @@ -62,7 +62,7 @@ tracetest run test -f ./ping-google.yaml

## Create a Test Visually with the Web UI

Create a test in the Web UI by opening your Tracetest Account. Click the Create button, and select HTTP.
Create a test in the Web UI by opening your Tracetest Account, clicking the Create button, and selecting HTTP.

![create response based test 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727177155/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_qc1291.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/create-trace-based-test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ tracetest run test -f ./import-pokemon.yaml

## Create a Trace-based Test Visually with the Web UI

Create a test in the Web UI by opening your Tracetest Account. Click the Create button, and select HTTP.
Create a test in the Web UI by opening your Tracetest account, clicking the Create button, and selecting HTTP.

![create trace based tests 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727192707/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_5_v178q5.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/getting-started/create-tracetest-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs';
This getting started guide is a quick start with [Cloud-based Managed Tracetest](https://app.tracetest.io/). To use [Enterprise On-prem Tracetest, refer to this guide](/install/on-prem-helm).
:::

1. [Sign in to Cloud-based Managed Tracetest](https://app.tracetest.io/).
1. [Sign into Cloud-based Managed Tracetest](https://app.tracetest.io/).
2. Create an [Organization](/concepts/organizations) and [Environment](/concepts/environments).
3. Copy your [Tracetest Organization API Key/Token and Environment ID](https://app.tracetest.io/retrieve-token).
6 changes: 3 additions & 3 deletions docs/docs/getting-started/install-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs';

[Tracetest Agent](/concepts/agent) runs alongside your apps, in the same environment/network, to do two things:

1. Run tests against your apps
2. Ingest traces from your apps
1. Run tests against your apps.
2. Ingest traces from your apps.

This page explains (1), how to start Tracetest Agent to enable running tests against your apps. Tracetest Agent can run either locally on your machine or as a container in Docker or Kubernetes.

Expand Down Expand Up @@ -63,7 +63,7 @@ You can:
:::note Docker Network
Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container.

To run tests against apps running on your local machine you have two options:
To run tests against apps running on your local machine, you have two options:

1. Run Tracetest Agent locally with the `tracetest start` command.
2. Add Tracetest Agent to the same network and use service name mapping. *Example: Instead of running an app on `localhost:8080`, add it to your Docker Compose file, connect it to the same network as your Tracetest Agent service, and use `<service-name>:8080` in the URL field when creating a test.*
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/install/on-prem-helm-kind.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T
---

:::note For Development Environment
This installation is meant for testing purposes only. It uses self signed certificates, so your browser will show a warning about it.
This installation is meant for testing purposes only. It uses self signed certificates so your browser will show a warning about it.
:::

:::tip For Production
Expand Down

0 comments on commit 941f309

Please sign in to comment.