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

chore(docs/examples): Adding GraphQL information #4001

Merged
merged 3 commits into from
Sep 2, 2024

Conversation

xoscar
Copy link
Contributor

@xoscar xoscar commented Aug 29, 2024

This PR adds the graphql docs and recipes

Changes

  • Adds the docs for graphql trigger
  • Adds a recipe for Graphql

Fixes

Checklist

  • tested locally
  • added new dependencies
  • updated the docs
  • added a test

@xoscar xoscar self-assigned this Aug 29, 2024
Copy link

vercel bot commented Aug 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tracetest ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 2, 2024 4:47pm

@xoscar xoscar requested review from yllek, adnanrahic and jfermi August 29, 2024 22:14
@xoscar xoscar marked this pull request as ready for review August 29, 2024 22:14

By creating a Tracetest GraphQL test, you will be able to create trace-based assertions to be applied across the entire flow like any other Tracetest test. Not only that but it allows you to mix and match it with your existing Monitors, Test Suites and CI/CD validations.

Another big benefit of using traces as test specs is that you can:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Another big benefit of using traces as test specs is that you can:
Other impactful benefits of using traces as test specs are:


Another big benefit of using traces as test specs is that you can:

- Get faster MTTR for failing performance tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Get faster MTTR for failing performance tests
- Faster MTTR for failing performance tests.

Another big benefit of using traces as test specs is that you can:

- Get faster MTTR for failing performance tests
- Assert against the Mutiple Queries and Mutations at once from a single test execution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Assert against the Mutiple Queries and Mutations at once from a single test execution
- Assert against the Mutiple Queries and Mutations at once from a single test execution.


- Get faster MTTR for failing performance tests
- Assert against the Mutiple Queries and Mutations at once from a single test execution
- Validate functionality of other parts of your system that may be broken, even when the initial request is passing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Validate functionality of other parts of your system that may be broken, even when the initial request is passing
- Validate functionality of other parts of your system that may be broken, even when the initial request is passing.


## Steps

1. [Install the tracetest CLI](https://docs.tracetest.io/installing/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. [Install the tracetest CLI](https://docs.tracetest.io/installing/)
1. [Install the tracetest CLI](https://docs.tracetest.io/installing/).

## Steps

1. [Install the tracetest CLI](https://docs.tracetest.io/installing/)
2. Run `tracetest configure --server-url http://localhost:11633` on a terminal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Run `tracetest configure --server-url http://localhost:11633` on a terminal
2. Run `tracetest configure --server-url http://localhost:11633` on a terminal.


1. [Install the tracetest CLI](https://docs.tracetest.io/installing/)
2. Run `tracetest configure --server-url http://localhost:11633` on a terminal
3. Update the `.env` file adding a valid set of AWS credentials
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. Update the `.env` file adding a valid set of AWS credentials
3. Update the `.env` file adding a valid set of AWS credentials.

1. [Install the tracetest CLI](https://docs.tracetest.io/installing/)
2. Run `tracetest configure --server-url http://localhost:11633` on a terminal
3. Update the `.env` file adding a valid set of AWS credentials
4. Update the `tracetest.provision.yaml` file adding a valid set of AWS credentials
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. Update the `tracetest.provision.yaml` file adding a valid set of AWS credentials
4. Update the `tracetest.provision.yaml` file adding a valid set of AWS credentials.

2. Run `tracetest configure --server-url http://localhost:11633` on a terminal
3. Update the `.env` file adding a valid set of AWS credentials
4. Update the `tracetest.provision.yaml` file adding a valid set of AWS credentials
5. Run the project by using docker-compose: `docker-compose up -d` (Linux) or `docker compose up -d` (Mac)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
5. Run the project by using docker-compose: `docker-compose up -d` (Linux) or `docker compose up -d` (Mac)
5. Run the project by using docker-compose: `docker-compose up -d` (Linux) or `docker compose up -d` (Mac).

Copy link
Contributor

@jfermi jfermi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some editing suggestions.

@xoscar xoscar merged commit f1014f8 into main Sep 2, 2024
38 checks passed
@xoscar xoscar deleted the chore-adding-graphql-docs branch September 2, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants