Skip to content

feat: add signoz template #5386

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

Draft
wants to merge 12 commits into
base: next
Choose a base branch
from

Conversation

GauthierPLM
Copy link

@GauthierPLM GauthierPLM commented Mar 20, 2025

Changes

  • Added Signoz template
  • Added an icon for Signoz

Issues

Further testing and improvement suggestions are welcome! :)
In particular, I am not sure my approach is the best one to expose the OTEL collector.

@GauthierPLM
Copy link
Author

Is there any way to ignore the example secret from the XML, since it's not a real secret?

@pkudinov
Copy link

@GauthierPLM Outstanding work! I just deployed it to test and it works.

Two questions

  1. It seems that sending logs over http using JSON is not supported. The use case is Vercel -> Self hosted Signoz.
    Here is the documentation: https://signoz.io/docs/userguide/send-logs-http/ Is that something you could easily add?

  2. The service shows up as unhealthy because below three containers (rightfully?) are down? Is this normal?

Image

@GauthierPLM
Copy link
Author

Hi @pkudinov

  1. It seems Coolify is not able to automatically set 2 URLs for a service, so you need to define it yourself like this: https://signoz-grpc.example.com:4317,https://signoz-http.example.com:4318

Since the docker compose exposes ports 4317 & 4318, you could also use the signoz service URL to call your machine, as long as the DNS return the machine IP (so no Cloudflare proxy).

  1. These three services are run at the compose start and then shutdown. They are all initialization / DB migration services that don't need to run for long.
    I'm also investigating to add healthchecks to the otel-collector container.

@pkudinov
Copy link

@GauthierPLM ,

4317&4318 are exposed and all good. I had to map them to subdomains in Cloudflare and all good.

But JSON logs are not working through tracing, they require port 8082 instead which is not being exposed as described in Signoz self-hosted documentation here: https://signoz.io/docs/userguide/send-logs-http/

@GauthierPLM GauthierPLM changed the title [WIP] feat: add signoz template feat: add signoz template Mar 24, 2025
@GauthierPLM
Copy link
Author

@pkudinov in this case, I will keep them no exposed and will let users do the setup would it be needed. This will follow the official behavior and (hopefully) save some confusion.

@peaklabs-dev peaklabs-dev added the ⚙️ Service Issues requesting or PRs adding/fixing service templates. label Mar 31, 2025
@flawnn
Copy link

flawnn commented Apr 5, 2025

Maybe this issue will not occur when actually using the template over the UI, but for me, when using the template via a Docker Compose Service in Coolify, I had permissions issues with the /etc/clickhouse/* files, specifically with the config of Clickhouse.

After manually 777'ing the files in the /data/coolify/services/<service_id>/clickhouse/* directory, everything seems to have worked out. But 777'ing shouldn't be the solution here as well, I guess.

@GauthierPLM
Copy link
Author

Maybe this issue will not occur when actually using the template over the UI, but for me, when using the template via a Docker Compose Service in Coolify, I had permissions issues with the /etc/clickhouse/* files, specifically with the config of Clickhouse.

After manually 777'ing the files in the /data/coolify/services/<service_id>/clickhouse/* directory, everything seems to have worked out. But 777'ing shouldn't be the solution here as well, I guess.

@flawnn do you have more details on the error you encountered? I haven't found any issue on my side.

@themodernpk
Copy link

+1

@kgotso
Copy link

kgotso commented Apr 20, 2025

Shouldn't the container named init-clickhouse share the same volume as the actual clickhouse container

@andrasbacsai andrasbacsai deleted the branch coollabsio:next May 9, 2025 06:31
@GGAlanSmithee
Copy link

sorry to bother, but is there any context to this being closed, or is this just dropped?

@andrasbacsai andrasbacsai reopened this May 9, 2025
@andrasbacsai
Copy link
Member

It was a mistake, sorry. I recreated the next branch and it auto-closed this PR.

@coollabsio coollabsio deleted a comment from gitguardian bot May 14, 2025
@coollabsio coollabsio deleted a comment from gitguardian bot May 14, 2025
@peaklabs-dev
Copy link
Member

@GauthierPLM The compose file is quite large. Is there a way to make it simpler to make it more maintainable?

@peaklabs-dev peaklabs-dev added the 💤 Waiting for feedback Issues awaiting a response from the author. label May 14, 2025
@GauthierPLM
Copy link
Author

@peaklabs-dev I think there would be two ways to improve the template maintainability:

  • Have SigNoz provide a tag pointing to the latest prod release (SigNoz doesn't have any yet, requested there: Docker Images: add tag to track latest stable release SigNoz/signoz#7388 ).
  • Have the confirmation that the bundled files match the default values / have them built in SigNoz' docker images. I discussed this with them but didn't have confirmation about which files could be removed from the template.

@prashant-shahi do you think we could move forward with any of these topics so the template could be integrated in Coolify?

@peaklabs-dev
Copy link
Member

Sounds good, please test this thoroughly and remove any unnecessary comments and containers to slim down the template as much as possible and let me know once everything works.

@peaklabs-dev peaklabs-dev marked this pull request as draft May 19, 2025 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚙️ Service Issues requesting or PRs adding/fixing service templates. 💤 Waiting for feedback Issues awaiting a response from the author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants