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 Tempo, Prometheus and Grafana to docker-compose #571

Conversation

eabasir
Copy link
Contributor

@eabasir eabasir commented Jun 15, 2024

Ticket

Closes #487

Description

I've added the config files needed for Temp, Proemtheus and Grafana (datasources) and updated the docker-compose file to start them. The authentication is intentionally skipped to make it easier for local use.

I've also updated the docker-compose to build the docker file locally and start the container based on the built image. I'm open to further discuss it, but here are my trail of thoughts:

  1. I've been troubled using the pushed version of gatewayd image as stated in Gatewayd container exits unsuccessfully on v0.9.6  #568.
  2. It would be easier for developers to work with the observability tools and other external services such as Postgres and Redis while developing the service, if the container is created based on the code in the development branch. In other words, having the container built based on the under-development code will facilitate the process of local-development

Development Checklist

  • I have added a descriptive title to this PR.
  • I have squashed related commits together.
  • I have rebased my branch on top of the latest main branch.
  • I have performed a self-review of my own code.
  • I have commented on my code, particularly in hard-to-understand areas.
  • I have added docstring(s) to my code.
  • I have made corresponding changes to the documentation (docs).
  • I have updated docs using make gen-docs command.
  • I have added tests for my changes.
  • I have signed all the commits.

Legal Checklist

@eabasir eabasir force-pushed the 487-add-prometheus-temp-grafana-to-docker-compose branch 3 times, most recently from 86b0198 to 187da4c Compare June 15, 2024 10:59
Copy link
Member

@mostafa mostafa left a comment

Choose a reason for hiding this comment

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

This code looks good to me, except the fact that the installation docs of GatewayD using docker compose assumes that the docker-compose.yml file is self-sufficient, but your changes assume that the user is a developer, hence they have a clone of the repository on their machine. This can be changed in two ways:

  1. Have two separate docker-compose files for users and developers.
  2. Keep your changes and change the docs to reflect that.

I am more leaning towards the first approach, and I've seen projects use this. Either way the docs should be updated to mention the new changes.

@eabasir
Copy link
Contributor Author

eabasir commented Jun 18, 2024

@mostafa To make the scope of the PR limited I'll proceed with the remote docker image. In another PR we can make different settings for developers

@eabasir eabasir force-pushed the 487-add-prometheus-temp-grafana-to-docker-compose branch from 187da4c to 0fe54b2 Compare June 18, 2024 19:30
@mostafa mostafa merged commit 0119784 into gatewayd-io:main Jun 18, 2024
5 checks passed
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.

Add Prometheus, Tempo and Grafana to docker compose file for observing GatewayD
2 participants