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

feat: add some new labels to every container #4324

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

Julien-R44
Copy link

@Julien-R44 Julien-R44 commented Nov 17, 2024

Changes

I strongly encourage to read the comment that initiated this PR: #3569 (comment)

TL;DR: The main issue is the difficulty in monitoring due to automatically generated container names. Currently, when I look at my Grafana/cAdvisor dashboard tracking CPU usage for each container managed by Coolify, I only see cuid names , which makes it impossible to identify what each container corresponds to.

So we need a way to have "human-readable" names for each container. This PR addresses the issue by adding three new labels to each container managed by Coolify :

  • coolify.resourceName: The name of the Application or Service
  • coolify.projectName: The name of the project where the resource lives
  • coolify.serviceName: This one might be a bit confusing, and perhaps we can find a better name. If the resource is of type Service, it will be the sub-service name. If it's of type Application, it will be the application name. This label is necessary because, using my monitoring use case as an example, I need metrics/logs for each of my containers. To differentiate them, I need a unique name. If I'm using a Service, I can't rely on coolify.resourceName since all the services in my docker-compose file would have the same value. I hope this explanation makes sense.

This is my first contribution to Coolify, and I'm not familiar with PHP either, so feel free to point out any corrections or improvements I should made

( And thanks a lot for making Coolify 💙 )

Issues

@peaklabs-dev
Copy link
Member

I get why this would be needed overall but I have a questions:

  1. Why does it have to be docker labels and not env variabels as we do have those COOLIFY_CONTAINER_NAME for example? And I will soon be adding things like Project name and so on as well to env vars.

@peaklabs-dev peaklabs-dev added the 🛠️ Feature Issues requesting a new feature. label Nov 17, 2024
@peaklabs-dev peaklabs-dev self-assigned this Nov 17, 2024
@Julien-R44
Copy link
Author

Because environment variables aren't collected by cAdvisor or anything I think. I suppose there's a way to tweak something, but with labels it works straight away. cAdvisor collects them, and I can use them in my PromQL queries ( Prometheus )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🛠️ Feature Issues requesting a new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants