Skip to content

Conversation

schoren
Copy link
Contributor

@schoren schoren commented Feb 19, 2024

This PR adds an example of how to run tracetest artillery integration

Changes

Fixes

Checklist

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

Loom video

Add your loom video here if your work can be visualized

Copy link

vercel bot commented Feb 19, 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 Mar 8, 2024 5:08pm

Copy link
Contributor

@adnanrahic adnanrahic left a comment

Choose a reason for hiding this comment

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

Awesome work! Added some suggestions and comments.


> [Read the detailed recipe for setting up Tracetest + Artillery in our documentation.](https://docs.tracetest.io/tools-and-integrations/artillery)

This is a quick start showing how you can create programs to run trace-based tests from your Artillery setup utilizing the tracetest engine and plugin. The example shows how to define the Tracetest tests, execute them, and wait for results to be ready. [Read the Typescript Quick Start Docs](https://docs.tracetest.io/tools-and-integrations/artillery) to see how to run this example.
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
This is a quick start showing how you can create programs to run trace-based tests from your Artillery setup utilizing the tracetest engine and plugin. The example shows how to define the Tracetest tests, execute them, and wait for results to be ready. [Read the Typescript Quick Start Docs](https://docs.tracetest.io/tools-and-integrations/artillery) to see how to run this example.
This is a quick start showing how you can create programs to run trace-based tests from your Artillery setup utilizing the tracetest engine and plugin. The example shows how to define the Tracetest tests, execute them, and wait for the results to be ready.

@@ -0,0 +1,21 @@
postgres:
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this file needed with the Tracetest Agent?

config:
target: my_target
tracetest:
token: tttoken_dfa1e954d47d1857
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we keep the token here or should we replace it with <YOUR_ENV_TOKEN>.

config:
target: my_target
tracetest:
token: tttoken_dfa1e954d47d1857
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we keep the token here or should we replace it with <YOUR_ENV_TOKEN>.

environment: "test"
tool: "Artillery"
tracetest:
token: tttoken_dfa1e954d47d1857
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we keep the token here or should we replace it with <YOUR_ENV_TOKEN>.

environment: "test"
tool: "Artillery"
tracetest:
token: tttoken_dfa1e954d47d1857
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we keep the token here or should we replace it with <YOUR_ENV_TOKEN>.

@@ -0,0 +1,27 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

Does the user need to run a command with the CLI to configure the provision or will it happen on-startup?

eg.

tracetest apply -f ./tracetest-provision.yaml

If it is needed, we might need to specify this?

environment:
TRACETEST_DEV: ${TRACETEST_DEV}
TRACETEST_API_KEY: ${TRACETEST_AGENT_API_KEY}
TRACETEST_SERVER_URL: ${TRACETEST_SERVER_URL}
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not specified in the .env file. Should we keep or remove it? It might confuse users.

@@ -0,0 +1 @@
TRACETEST_AGENT_API_KEY= No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be possible to add the TRACETEST_API_TOKEN here as well and load it in the yaml files? This could mean removing the hardcoded token values from the yamls and making sure the user only sets it once.

@adnanrahic
Copy link
Contributor

Also, @xoscar -- Are you planning on writing the docs recipe in this PR to be released together? I can help with that if needed.

…3709)

* chore(examples): Adding Artillery + Playwright + Tracetest example

* docs(recipes): add pw + artillery + tt

---------

Co-authored-by: Adnan Rahic <[email protected]>
@xoscar xoscar merged commit c861835 into main Mar 8, 2024
@xoscar xoscar deleted the quickstart-artillery branch March 8, 2024 17:27
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.

4 participants