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

Add observability to the rescue example #2736

Merged
merged 13 commits into from
Jun 16, 2023

Conversation

danielbdias
Copy link
Contributor

@danielbdias danielbdias commented Jun 15, 2023

This PR adds a new example called "Observability to the Rescue! Monitoring and testing APIs with OpenTelemetry".

Loom: https://www.loom.com/share/9a5bdadfafc2417bb4534bb73487b0c6?sid=4116c7ed-5683-4bc6-8c31-deef4aadf896

Changes

  • Add example folder

Checklist

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

@adnanrahic
Copy link
Contributor

This is beautiful. 👌

@danielbdias danielbdias changed the title Add/observability to the rescue example Add observability to the rescue example Jun 15, 2023
@danielbdias danielbdias marked this pull request as ready for review June 15, 2023 17:02
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! Added some comments for the readme.

examples/observability-to-the-rescue/README.md Outdated Show resolved Hide resolved
examples/observability-to-the-rescue/README.md Outdated Show resolved Hide resolved
examples/observability-to-the-rescue/README.md Outdated Show resolved Hide resolved
examples/observability-to-the-rescue/README.md Outdated Show resolved Hide resolved
# internal error!
```

## Trace-based tests that you can run
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a short description of what these two tests are doing?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

@danielbdias danielbdias force-pushed the add/observability-to-the-rescue-example branch from bc0e32f to d2acf6e Compare June 16, 2023 13:16
Copy link
Contributor

@mathnogueira mathnogueira left a comment

Choose a reason for hiding this comment

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

Looks good. I don't know ruby very well though

Comment on lines +22 to +28
# ---
# type: Analyzer
# spec:
# id: current
# name: Analyzer
# enabled: false
# minimumScore: 0
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason for having this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is because the Analyzer provisioning is broken for empty plugins. @xoscar solved it yesterday and as soon as we release a new version, I will uncomment this.

type: Test
spec:
id: yWoVaiuVR
name: Your API call with error
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the error in this case? All assertions are waiting 200 OK status.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe it's worth adding a description to the test to explain the usecase

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It makes sense to add a description. This is a test that is expected to fail, to simulate the problem that I'm presenting on the talk.
Context: https://www.loom.com/share/ab3579b2f5fa4fd4af58e088bcad8513?t=852&sid=2b4e5820-2e11-4e42-a9ae-08f33a594e36 (at the 14 min of the talk)

@danielbdias danielbdias merged commit 592188a into main Jun 16, 2023
@danielbdias danielbdias deleted the add/observability-to-the-rescue-example branch June 16, 2023 20:29
mathnogueira added a commit that referenced this pull request Jun 19, 2023
* Adding initial APIs for the example

* Adding code for payment-executor-api

* Adding full example

* Adding trace-based tests

* Updating README

* Apply suggestions from code review

Co-authored-by: Adnan Rahić <[email protected]>

* Adding documentation to the example

* fix(backend): matching trigger span duration and trigger time durations (#2740)

* fix(frontend): adding default value for data store connection types (#2742)

* fix(backend): fixing response status code for grpc request (#2741)

* feat: add upsert method and enable it for environments (#2746)

* add upsert method and enable it for environments

* handle error when getting entity

* PR suggestions

---------

Co-authored-by: Adnan Rahić <[email protected]>
Co-authored-by: Oscar Reyes <[email protected]>
Co-authored-by: Matheus Nogueira <[email protected]>
mathnogueira added a commit that referenced this pull request Jun 19, 2023
* Adding initial APIs for the example

* Adding code for payment-executor-api

* Adding full example

* Adding trace-based tests

* Updating README

* Apply suggestions from code review

Co-authored-by: Adnan Rahić <[email protected]>

* Adding documentation to the example

* fix(backend): matching trigger span duration and trigger time durations (#2740)

* fix(frontend): adding default value for data store connection types (#2742)

* fix(backend): fixing response status code for grpc request (#2741)

* feat: add upsert method and enable it for environments (#2746)

* add upsert method and enable it for environments

* handle error when getting entity

* PR suggestions

---------

Co-authored-by: Adnan Rahić <[email protected]>
Co-authored-by: Oscar Reyes <[email protected]>
Co-authored-by: Matheus Nogueira <[email protected]>
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