Support multiple docker socket #2471

loopback-kr · 2023-06-23T01:59:41Z

Description

Docker can separate docker context by user. That is, we can have multiple docker.sock files per user. The /var/run/docker.sock file is default socket file for default context, but run/user/<USER-ID>/docker.sock file also can exists for each user account, and the user can switch context and use docker in that context. eg, docker rootless mode, but i think glances binds only one docker.sock file through the volume option when create a new container of glances.

I wish glances could take multiple docker.sock files and monitor containers per context when glances.conf is set as below.

[containers]
# Define Podman sock
#podman_sock=unix:///run/user/1000/podman/podman.sock
# Define Docker sock
#docker_sock=unix:///var/run/docker.sock
docker_sock=unix:///run/user/1000/docker.sock,unix:///run/user/1001/docker.sock

I just push a draft version for CLI mode.
The web interface and Podman parts also need to be implemented.
I hope it's worth it. Thanks.

Resume

Bug fix: no
New feature: yes
Fixed tickets: comma-separated list of tickets fixed by the PR, if any

nicolargo

Hi @loopback-kr !

Thanks for the interesting PR.

For the moment, i can not merge it to the develop branch. I have added some comments inside your code.

Nicolas

nicolargo · 2023-06-24T07:15:51Z

docker-compose/glances.conf

@@ -424,6 +424,8 @@ max_name_size=20
 all=False
 # Define Podman sock
 #podman_sock=unix:///run/user/1000/podman/podman.sock
+# Define Docker sock
+docker_sock=unix:///var/run/docker.sock


It will be better to let default value of docker_sock to empty (not defined) in order to use (by default) the standard docker.from_env() builder.
Glances is multi-platform and i am pretty sure that the default value of docker_sock on Windows is not unix:///var/run/docker.sock.

+1 for this

nicolargo · 2023-06-24T07:17:24Z

glances/plugins/containers/engines/docker.py

@@ -215,25 +215,26 @@ class DockerContainersExtension:

 CONTAINER_ACTIVE_STATUS = ['running', 'paused']

- def __init__(self):
+ def __init__(self, server_urls:str|list = 'unix:///var/run/docker.sock'):


Same remark, let the server_urls default value to '' (empty).

Just something to note with Python support.

Glances v4 would be target Py3.8+

The str | list syntax was only support from Py3.10 onwards, iirc.
So better use the older Union[] style to prevent older interpreters from crashing.

Also I think returning a list[str] even when there is only a single elemenet would reduce unnecessary type checks later

nicolargo · 2023-06-24T07:17:37Z

glances/plugins/containers/engines/docker.py


- def connect(self):
+ def connect(self, base_urls:str|list = 'unix:///var/run/docker.sock'):


nicolargo · 2023-06-24T07:18:54Z

glances/plugins/containers/engines/docker.py

 try:
 # Do not use the timeout option (see issue #1878)
- self.client = docker.from_env()


test if base_urls is empty then use from_env() else use the base_urls list instead

nicolargo · 2023-06-24T07:19:49Z

glances/plugins/containers/model.py


 # Init the Podman API
 if import_podman_error_tag:
 self.podman_client = None
 else:
- self.podman_client = PodmanContainersExtension(podman_sock=self._podman_sock())
+ self.podman_client = PodmanContainersExtension(podman_sock=self._podman_sock()) # TODO: podman also


IS it also possible to have multiple socket for Podman ?

@nicolargo
Yep.
In fact its more common to have custom socket's in the podman ecosystem.

nicolargo · 2023-06-24T07:20:22Z

glances/plugins/containers/model.py

+ """
+ conf_docker_sock = self.get_conf_value('docker_sock')
+ if len(conf_docker_sock) == 0:
+ return "unix:///var/run/docker.sock"


To be refactor according to previous comments

RazCrimson · 2023-06-24T08:30:19Z

glances/plugins/containers/engines/docker.py


- def connect(self):
+ def connect(self, base_urls:str|list = 'unix:///var/run/docker.sock'):


Same as typing issue above

RazCrimson · 2023-06-24T10:39:12Z

docker-compose/glances.conf

@@ -424,6 +424,8 @@ max_name_size=20
 all=False
 # Define Podman sock
 #podman_sock=unix:///run/user/1000/podman/podman.sock
+# Define Docker sock
+docker_sock=unix:///var/run/docker.sock


+1 for this

RazCrimson · 2023-06-24T10:41:58Z

glances/plugins/containers/engines/docker.py

@@ -215,25 +215,26 @@ class DockerContainersExtension:

 CONTAINER_ACTIVE_STATUS = ['running', 'paused']

- def __init__(self):
+ def __init__(self, server_urls:str|list = 'unix:///var/run/docker.sock'):


Just something to note with Python support.

Glances v4 would be target Py3.8+

The str | list syntax was only support from Py3.10 onwards, iirc.
So better use the older Union[] style to prevent older interpreters from crashing.

Also I think returning a list[str] even when there is only a single elemenet would reduce unnecessary type checks later

RazCrimson · 2023-06-24T10:49:25Z

glances/plugins/containers/engines/docker.py

 try:
 # Do not use the timeout option (see issue #1878)
- self.client = docker.from_env()
+ self.clients = [docker.DockerClient(url) for url in base_urls]


This will end up failing/dropping all socket connections if any one of them fail.

I think a more tolerant approach where we just ignore the connections that fail would be better as they user will still get to see some of the containers if they are active.

A log message indicating the failed socket would be helpful for debugging

RazCrimson · 2023-06-24T10:50:45Z

glances/plugins/containers/engines/docker.py

@@ -257,7 +258,8 @@ def update(self, all_tag):
 try:
 # Issue #1152: Docker module doesn't export details about stopped containers
 # The Containers/all key of the configuration file should be set to True
- containers = self.client.containers.list(all=all_tag)
+ containers = []
+ [[containers.append(container_per_client) for container_per_client in client.containers.list(all=all_tag)] for client in self.clients]


Same problem as mentioned earlier, if one of the socket connections break or the server ends up serving a malformed response, then we will end up with no results.

RazCrimson · 2023-06-24T10:51:45Z

glances/plugins/containers/model.py


 # Init the Podman API
 if import_podman_error_tag:
 self.podman_client = None
 else:
- self.podman_client = PodmanContainersExtension(podman_sock=self._podman_sock())
+ self.podman_client = PodmanContainersExtension(podman_sock=self._podman_sock()) # TODO: podman also


@nicolargo
Yep.
In fact its more common to have custom socket's in the podman ecosystem.

RazCrimson · 2023-06-24T10:53:40Z

glances/plugins/containers/model.py

@@ -297,6 +307,8 @@ def msg_curse(self, args=None, max_width=None):
 ret.append(self.curse_add_line(msg))
 msg = ' {:<7}'.format('Tx/s')
 ret.append(self.curse_add_line(msg))
+ msg = '{:<30}'.format('Socket URL')


We also should display this only optionally. As in the user can opt in if they want this to be displayed.

The containers plugin has very little screen room, so this will reduce it even further

RazCrimson · 2023-07-22T13:43:32Z

@loopback-kr
I'll take care of the clean up and merge, if you don't mind.
Please let me know if you want to get this done by yourself.

Thanks for the contribution!

loopback-kr · 2023-07-23T10:53:10Z

There is not enough time for this work. I would be happy if you could complete the code for me.

loopback-kr added 6 commits June 19, 2023 17:46

Add TODO

4d6052e

Implement multi clients

bfc90de

Glances can receive multiple docker host urls

f26668d

Add docker_sock

2bdc252

Fixed unix url format

00cd27f

Add Socket URL to stats

72cfaf7

nicolargo requested changes Jun 24, 2023

View reviewed changes

nicolargo added needs discussion needs contributor refactoring labels Jun 24, 2023

nicolargo requested a review from RazCrimson June 24, 2023 07:32

RazCrimson reviewed Jun 24, 2023

View reviewed changes

RazCrimson added this to the Glances 4.1.0 milestone May 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support multiple docker socket #2471

Support multiple docker socket #2471

loopback-kr commented Jun 23, 2023

nicolargo left a comment

nicolargo Jun 24, 2023

RazCrimson Jun 24, 2023

nicolargo Jun 24, 2023

RazCrimson Jun 24, 2023

nicolargo Jun 24, 2023

nicolargo Jun 24, 2023

nicolargo Jun 24, 2023

RazCrimson Jun 24, 2023

nicolargo Jun 24, 2023

RazCrimson Jun 24, 2023

RazCrimson Jun 24, 2023

RazCrimson Jun 24, 2023

RazCrimson Jun 24, 2023

RazCrimson Jun 24, 2023

RazCrimson Jun 24, 2023

RazCrimson Jun 24, 2023

RazCrimson commented Jul 22, 2023 •

edited

loopback-kr commented Jul 23, 2023


		def connect(self):
		def connect(self, base_urls:str\|list = 'unix:///var/run/docker.sock'):

Support multiple docker socket #2471

Are you sure you want to change the base?

Support multiple docker socket #2471

Conversation

loopback-kr commented Jun 23, 2023

Description

Resume

nicolargo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RazCrimson commented Jul 22, 2023 • edited

loopback-kr commented Jul 23, 2023

RazCrimson commented Jul 22, 2023 •

edited