feat: add signoz template

[GauthierPLM]

Changes

• Added Signoz template
• Added an icon for Signoz

Issues

• fix #4132
• fix https://github.com/SigNoz/signoz/issues/6368

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]

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

[pkudinov]

@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?

[GauthierPLM]

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).

2. 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]

@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]

@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.

[flawnn]

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]

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]

+1

[kgotso]

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

[GGAlanSmithee]

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

[andrasbacsai]

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

[peaklabs-dev]

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

[GauthierPLM]

@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: 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]

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.

[knotbin]

+1

[satyam7world]

+1

[Cizzl]

+1

[makeavish]

Hey @GauthierPLM SigNoz now provides a latest stable tag: https://github.com/SigNoz/signoz/issues/6368#issuecomment-2961910306

[gitguardian[bot]]

️✅ There are no secrets present in this pull request anymore.

If these secrets were true positive and are still valid, we highly recommend you to revoke them. While these secrets were previously flagged, we no longer have a reference to the specific commits where they were detected. Once a secret has been leaked into a git repository, you should consider it compromised, even if it was deleted immediately. Find here more information about risks.

---

^{_{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}}

[GauthierPLM]

I updated the template to use the new tags added by the SigNoz team + reduced the template size by only bundling the config that change.

Tests are more than welcome to confirm everything works as expected, especially with the config change.

[ridane]

+1

[makeavish]

@peaklabs-dev PTAL at this PR again

[Nageshbansal]

Hey @peaklabs-dev, could you please review this PR again

[SegoviaDiego]

I'm trying to test this on my local Coolify instance but I'm also getting the permissions error messages @flawnn mentioned before.

This is the error:

2025-07-24T19:56:18.858160416Z Processing configuration file '/etc/clickhouse-server/config.xml'.
2025-07-24T19:56:18.950113246Z Poco::Exception. Code: 1000, e.code() = 13, Access to file denied: /etc/clickhouse-server/config.xml, Stack trace (when copying this message, always include the lines below):

Here are the full logs:

2025-07-24T19:56:17.622161747Z  (version 24.1.2.5 (official build))
2025-07-24T19:56:18.679836694Z Poco::Exception. Code: 1000, e.code() = 0, Not found: path (version 24.1.2.5 (official build))
2025-07-24T19:56:18.700291694Z Poco::Exception. Code: 1000, e.code() = 0, Not found: tmp_path (version 24.1.2.5 (official build))
2025-07-24T19:56:18.720808472Z Poco::Exception. Code: 1000, e.code() = 0, Not found: user_files_path (version 24.1.2.5 (official build))
2025-07-24T19:56:18.741198617Z Poco::Exception. Code: 1000, e.code() = 0, Not found: logger.log (version 24.1.2.5 (official build))
2025-07-24T19:56:18.761770015Z Poco::Exception. Code: 1000, e.code() = 0, Not found: logger.errorlog (version 24.1.2.5 (official build))
2025-07-24T19:56:18.782496752Z Poco::Exception. Code: 1000, e.code() = 0, Not found: format_schema_path (version 24.1.2.5 (official build))
2025-07-24T19:56:18.858160416Z Processing configuration file '/etc/clickhouse-server/config.xml'.
2025-07-24T19:56:18.950113246Z Poco::Exception. Code: 1000, e.code() = 13, Access to file denied: /etc/clickhouse-server/config.xml, Stack trace (when copying this message, always include the lines below):
2025-07-24T19:56:18.950139080Z 
2025-07-24T19:56:18.950142653Z 0. Poco::FileAccessDeniedException::FileAccessDeniedException(String const&, int) @ 0x0000000015468529 in /usr/bin/clickhouse
2025-07-24T19:56:18.950146341Z 1. Poco::FileImpl::handleLastErrorImpl(String const&) @ 0x0000000015469b70 in /usr/bin/clickhouse
2025-07-24T19:56:18.950150164Z 2. ? @ 0x000000001546b506 in /usr/bin/clickhouse
2025-07-24T19:56:18.950153117Z 3. ? @ 0x0000000015476f89 in /usr/bin/clickhouse
2025-07-24T19:56:18.950155791Z 4. Poco::FileInputStream::FileInputStream(String const&, unsigned int) @ 0x000000001547757b in /usr/bin/clickhouse
2025-07-24T19:56:18.950158940Z 5. Poco::FileStreamFactory::open(Poco::Path const&) @ 0x00000000154a7d25 in /usr/bin/clickhouse
2025-07-24T19:56:18.950161976Z 6. Poco::URIStreamOpener::open(String const&) const @ 0x00000000154a6e79 in /usr/bin/clickhouse
2025-07-24T19:56:18.950164962Z 7. Poco::XML::EntityResolverImpl::resolveSystemId(String const&) @ 0x00000000153db9d5 in /usr/bin/clickhouse
2025-07-24T19:56:18.950167724Z 8. Poco::XML::EntityResolverImpl::resolveEntity(String const*, String const&) @ 0x00000000153db739 in /usr/bin/clickhouse
2025-07-24T19:56:18.950170610Z 9. Poco::XML::SAXParser::parse(String const&) @ 0x00000000153d4352 in /usr/bin/clickhouse
2025-07-24T19:56:18.950184842Z 10. Poco::XML::DOMBuilder::parse(String const&) @ 0x00000000153c59d8 in /usr/bin/clickhouse
2025-07-24T19:56:18.950187122Z 11. Poco::XML::DOMParser::parse(String const&) @ 0x00000000153c4ea2 in /usr/bin/clickhouse
2025-07-24T19:56:18.950189271Z 12. DB::ConfigProcessor::processConfig(bool*, zkutil::ZooKeeperNodeCache*, std::shared_ptr<Poco::Event> const&) @ 0x0000000012fdfbc0 in /usr/bin/clickhouse
2025-07-24T19:56:18.950191771Z 13. DB::ConfigProcessor::loadConfig(bool) @ 0x0000000012fe3534 in /usr/bin/clickhouse
2025-07-24T19:56:18.950193973Z 14. BaseDaemon::initialize(Poco::Util::Application&) @ 0x000000000cae4de0 in /usr/bin/clickhouse
2025-07-24T19:56:18.950196205Z 15. DB::Server::initialize(Poco::Util::Application&) @ 0x000000000c88fc18 in /usr/bin/clickhouse
2025-07-24T19:56:18.950198344Z 16. Poco::Util::Application::run() @ 0x00000000153b26ba in /usr/bin/clickhouse
2025-07-24T19:56:18.950200424Z 17. DB::Server::run() @ 0x000000000c88f9d1 in /usr/bin/clickhouse
2025-07-24T19:56:18.950202476Z 18. Poco::Util::ServerApplication::run(int, char**) @ 0x00000000153bb539 in /usr/bin/clickhouse
2025-07-24T19:56:18.950205607Z 19. mainEntryClickHouseServer(int, char**) @ 0x000000000c88c8ca in /usr/bin/clickhouse
2025-07-24T19:56:18.950207708Z 20. main @ 0x0000000007216ad8 in /usr/bin/clickhouse
2025-07-24T19:56:18.950209823Z 21. ? @ 0x00007477e4eda083
2025-07-24T19:56:18.950211971Z 22. _start @ 0x0000000005f6f12e in /usr/bin/clickhouse
2025-07-24T19:56:18.950214045Z  (version 24.1.2.5 (official build))
2025-07-24T19:56:20.791449154Z Poco::Exception. Code: 1000, e.code() = 0, Not found: path (version 24.1.2.5 (official build))
2025-07-24T19:56:20.812365900Z Poco::Exception. Code: 1000, e.code() = 0, Not found: tmp_path (version 24.1.2.5 (official build))
2025-07-24T19:56:20.832246026Z Poco::Exception. Code: 1000, e.code() = 0, Not found: user_files_path (version 24.1.2.5 (official build))
2025-07-24T19:56:20.852856205Z Poco::Exception. Code: 1000, e.code() = 0, Not found: logger.log (version 24.1.2.5 (official build))
2025-07-24T19:56:20.872913890Z Poco::Exception. Code: 1000, e.code() = 0, Not found: logger.errorlog (version 24.1.2.5 (official build))
2025-07-24T19:56:20.893353017Z Poco::Exception. Code: 1000, e.code() = 0, Not found: format_schema_path (version 24.1.2.5 (official build))
2025-07-24T19:56:20.965494279Z Processing configuration file '/etc/clickhouse-server/config.xml'.
2025-07-24T19:56:21.031668532Z Poco::Exception. Code: 1000, e.code() = 13, Access to file denied: /etc/clickhouse-server/config.xml, Stack trace (when copying this message, always include the lines below):
2025-07-24T19:56:21.031698414Z 
2025-07-24T19:56:21.031702885Z 0. Poco::FileAccessDeniedException::FileAccessDeniedException(String const&, int) @ 0x0000000015468529 in /usr/bin/clickhouse
2025-07-24T19:56:21.031707725Z 1. Poco::FileImpl::handleLastErrorImpl(String const&) @ 0x0000000015469b70 in /usr/bin/clickhouse
2025-07-24T19:56:21.031733202Z 2. ? @ 0x000000001546b506 in /usr/bin/clickhouse
2025-07-24T19:56:21.031736705Z 3. ? @ 0x0000000015476f89 in /usr/bin/clickhouse
2025-07-24T19:56:21.031739825Z 4. Poco::FileInputStream::FileInputStream(String const&, unsigned int) @ 0x000000001547757b in /usr/bin/clickhouse
2025-07-24T19:56:21.031743105Z 5. Poco::FileStreamFactory::open(Poco::Path const&) @ 0x00000000154a7d25 in /usr/bin/clickhouse
2025-07-24T19:56:21.031746482Z 6. Poco::URIStreamOpener::open(String const&) const @ 0x00000000154a6e79 in /usr/bin/clickhouse
2025-07-24T19:56:21.031750054Z 7. Poco::XML::EntityResolverImpl::resolveSystemId(String const&) @ 0x00000000153db9d5 in /usr/bin/clickhouse
2025-07-24T19:56:21.031753429Z 8. Poco::XML::EntityResolverImpl::resolveEntity(String const*, String const&) @ 0x00000000153db739 in /usr/bin/clickhouse
2025-07-24T19:56:21.031756934Z 9. Poco::XML::SAXParser::parse(String const&) @ 0x00000000153d4352 in /usr/bin/clickhouse
2025-07-24T19:56:21.031760266Z 10. Poco::XML::DOMBuilder::parse(String const&) @ 0x00000000153c59d8 in /usr/bin/clickhouse
2025-07-24T19:56:21.031763442Z 11. Poco::XML::DOMParser::parse(String const&) @ 0x00000000153c4ea2 in /usr/bin/clickhouse
2025-07-24T19:56:21.031766656Z 12. DB::ConfigProcessor::processConfig(bool*, zkutil::ZooKeeperNodeCache*, std::shared_ptr<Poco::Event> const&) @ 0x0000000012fdfbc0 in /usr/bin/clickhouse
2025-07-24T19:56:21.031770238Z 13. DB::ConfigProcessor::loadConfig(bool) @ 0x0000000012fe3534 in /usr/bin/clickhouse
2025-07-24T19:56:21.031773372Z 14. BaseDaemon::initialize(Poco::Util::Application&) @ 0x000000000cae4de0 in /usr/bin/clickhouse
2025-07-24T19:56:21.031776802Z 15. DB::Server::initialize(Poco::Util::Application&) @ 0x000000000c88fc18 in /usr/bin/clickhouse
2025-07-24T19:56:21.031779961Z 16. Poco::Util::Application::run() @ 0x00000000153b26ba in /usr/bin/clickhouse
2025-07-24T19:56:21.031783098Z 17. DB::Server::run() @ 0x000000000c88f9d1 in /usr/bin/clickhouse
2025-07-24T19:56:21.031785976Z 18. Poco::Util::ServerApplication::run(int, char**) @ 0x00000000153bb539 in /usr/bin/clickhouse
2025-07-24T19:56:21.031789863Z 19. mainEntryClickHouseServer(int, char**) @ 0x000000000c88c8ca in /usr/bin/clickhouse
2025-07-24T19:56:21.031792954Z 20. main @ 0x0000000007216ad8 in /usr/bin/clickhouse
2025-07-24T19:56:21.031795808Z 21. ? @ 0x00007c4a95b60083
2025-07-24T19:56:21.031798569Z 22. _start @ 0x0000000005f6f12e in /usr/bin/clickhouse
2025-07-24T19:56:21.031801501Z  (version 24.1.2.5 (official build))
2025-07-24T19:56:24.473187684Z Poco::Exception. Code: 1000, e.code() = 0, Not found: path (version 24.1.2.5 (official build))
2025-07-24T19:56:24.492879264Z Poco::Exception. Code: 1000, e.code() = 0, Not found: tmp_path (version 24.1.2.5 (official build))
2025-07-24T19:56:24.515162283Z Poco::Exception. Code: 1000, e.code() = 0, Not found: user_files_path (version 24.1.2.5 (official build))
2025-07-24T19:56:24.535674740Z Poco::Exception. Code: 1000, e.code() = 0, Not found: logger.log (version 24.1.2.5 (official build))
2025-07-24T19:56:24.555837361Z Poco::Exception. Code: 1000, e.code() = 0, Not found: logger.errorlog (version 24.1.2.5 (official build))
2025-07-24T19:56:24.578031451Z Poco::Exception. Code: 1000, e.code() = 0, Not found: format_schema_path (version 24.1.2.5 (official build))
2025-07-24T19:56:24.652390225Z Processing configuration file '/etc/clickhouse-server/config.xml'.
2025-07-24T19:56:24.718211613Z Poco::Exception. Code: 1000, e.code() = 13, Access to file denied: /etc/clickhouse-server/config.xml, Stack trace (when copying this message, always include the lines below):
2025-07-24T19:56:24.718240773Z 
2025-07-24T19:56:24.718244210Z 0. Poco::FileAccessDeniedException::FileAccessDeniedException(String const&, int) @ 0x0000000015468529 in /usr/bin/clickhouse
2025-07-24T19:56:24.718248275Z 1. Poco::FileImpl::handleLastErrorImpl(String const&) @ 0x0000000015469b70 in /usr/bin/clickhouse
2025-07-24T19:56:24.718251806Z 2. ? @ 0x000000001546b506 in /usr/bin/clickhouse
2025-07-24T19:56:24.718254747Z 3. ? @ 0x0000000015476f89 in /usr/bin/clickhouse
2025-07-24T19:56:24.718258459Z 4. Poco::FileInputStream::FileInputStream(String const&, unsigned int) @ 0x000000001547757b in /usr/bin/clickhouse
2025-07-24T19:56:24.718261933Z 5. Poco::FileStreamFactory::open(Poco::Path const&) @ 0x00000000154a7d25 in /usr/bin/clickhouse
2025-07-24T19:56:24.718265603Z 6. Poco::URIStreamOpener::open(String const&) const @ 0x00000000154a6e79 in /usr/bin/clickhouse
2025-07-24T19:56:24.718268883Z 7. Poco::XML::EntityResolverImpl::resolveSystemId(String const&) @ 0x00000000153db9d5 in /usr/bin/clickhouse
2025-07-24T19:56:24.718272337Z 8. Poco::XML::EntityResolverImpl::resolveEntity(String const*, String const&) @ 0x00000000153db739 in /usr/bin/clickhouse
2025-07-24T19:56:24.718275393Z 9. Poco::XML::SAXParser::parse(String const&) @ 0x00000000153d4352 in /usr/bin/clickhouse
2025-07-24T19:56:24.718278621Z 10. Poco::XML::DOMBuilder::parse(String const&) @ 0x00000000153c59d8 in /usr/bin/clickhouse
2025-07-24T19:56:24.718281647Z 11. Poco::XML::DOMParser::parse(String const&) @ 0x00000000153c4ea2 in /usr/bin/clickhouse
2025-07-24T19:56:24.718285000Z 12. DB::ConfigProcessor::processConfig(bool*, zkutil::ZooKeeperNodeCache*, std::shared_ptr<Poco::Event> const&) @ 0x0000000012fdfbc0 in /usr/bin/clickhouse
2025-07-24T19:56:24.718288740Z 13. DB::ConfigProcessor::loadConfig(bool) @ 0x0000000012fe3534 in /usr/bin/clickhouse
2025-07-24T19:56:24.718291964Z 14. BaseDaemon::initialize(Poco::Util::Application&) @ 0x000000000cae4de0 in /usr/bin/clickhouse
2025-07-24T19:56:24.718294903Z 15. DB::Server::initialize(Poco::Util::Application&) @ 0x000000000c88fc18 in /usr/bin/clickhouse
2025-07-24T19:56:24.718298268Z 16. Poco::Util::Application::run() @ 0x00000000153b26ba in /usr/bin/clickhouse
2025-07-24T19:56:24.718301312Z 17. DB::Server::run() @ 0x000000000c88f9d1 in /usr/bin/clickhouse
2025-07-24T19:56:24.718304426Z 18. Poco::Util::ServerApplication::run(int, char**) @ 0x00000000153bb539 in /usr/bin/clickhouse
2025-07-24T19:56:24.718322955Z 19. mainEntryClickHouseServer(int, char**) @ 0x000000000c88c8ca in /usr/bin/clickhouse
2025-07-24T19:56:24.718326137Z 20. main @ 0x0000000007216ad8 in /usr/bin/clickhouse
2025-07-24T19:56:24.718329229Z 21. ? @ 0x000071b14cb20083
2025-07-24T19:56:24.718332303Z 22. _start @ 0x0000000005f6f12e in /usr/bin/clickhouse
2025-07-24T19:56:24.718335322Z  (version 24.1.2.5 (official build))

[GauthierPLM]

@SegoviaDiego @flawnn I tried to reproduce the issue but couldn't. Do you use Coolify with non-root user? https://coolify.io/docs/knowledge-base/server/non-root-user#:~:text=Non-root%20user

I encountered permission issues with other services (mostly Postgres DBs) due to how Coolify handle permissions for non-root users. Basically, Coolify re-apply its user' ownership & chmod to the files mounted in the container. I suspect this cause the file' permission to restrict the Clickhouse process from reading /etc/clickhouse-server/config.xml.

Could you check the permissions of the Clickhouse config files in the service' directory? Open a terminal on your server, go to /data/coolify/services/<SERVICE ID>/clickhouse and ls -l the directory. This is what I have on the instance deployed with the compose used in this PR:

[SegoviaDiego]

@GauthierPLM First off, thank you so much for the help and for your work on the SigNoz integration. You're the best 🙌

You were absolutely right about the issue. I'm not using the root user since AWS Lightsail defaults to a non-root setup. To enable SSH as root, I had to remove the restriction from the default key (more details are available in this link)

After doing that and reinstalling the Coolify server on that VPS, everything started working as expected. I really appreciate the quick response and your insight.

The only issue I’m seeing now is that after running the deployment, SigNoz works as expected but the service still shows up as unhealthy. I’m guessing this is related to the three jobs you mentioned that are expected to be unhealthy initially. Just wanted to check if there’s a known way to fix or silence that warning. I’ve attached some screenshots below in case it helps.

Regarding your question, here is the output of ls -l on my server:

-rwxr-x--- 1 ubuntu ubuntu 2854 Jul 28 14:35 cluster.xml
-rwxr-x--- 1 ubuntu ubuntu 2729 Jul 28 14:35 config.xml
-rwxr-x--- 1 ubuntu ubuntu  575 Jul 28 14:35 custom-function.xml
-rwxr-x--- 1 ubuntu ubuntu 6220 Jul 28 14:35 users.xml

Thanks again for the support. You saved me hours of debugging 🙏

[GauthierPLM]

@SegoviaDiego you can open the containers' settings page and check « Exclude from service status ». Since these containers stop after execution, there is no other way to avoid unhealthy status for the whole service.

Regarding the permissions, it confirms what I suspected: running Coolify as non-root mess with the permissions. The solution here would be to make the files readable by everyone (chmod o+r * in the clickhouse folder). That should allow Clickhouse to access the files as needed.

[therealpandey]

Hi @peaklabs-dev,

Can we get this merged? I see the comments are addressed.

[zzimbler]

Would love for this to get merged ❤️

[josselinlbe]

🎉