Nats connection names #11144

jvillafanez · 2025-03-18T18:03:53Z

Description

Change the connection names according to the format hostname:pid:service:type

root@f0895c1d67d2:/# nats account report connections

╭───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│                                                                                  Top 24 Connections out of 24 by subs                                                                                 │
├─────┬──────────────────────────────┬──────────────────────────────────────────────────────────┬──────────────┬──────────────────┬─────────┬────────┬─────────┬──────────┬──────────┬───────────┬──────┤
│ CID │ Name                         │ Server                                                   │ Cluster      │ IP               │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
├─────┼──────────────────────────────┼──────────────────────────────────────────────────────────┼──────────────┼──────────────────┼─────────┼────────┼─────────┼──────────┼──────────┼───────────┼──────┤
│ 34  │ initial                      │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53014  │         │ 1m7s   │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 46  │ f0895:13:proxy:bus           │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53024  │         │ 1m6s   │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 64  │ f0895:13:sharing:bus         │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53086  │         │ 1m5s   │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 63  │ f0895:13:storage-users:bus   │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53084  │         │ 1m5s   │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 62  │ storageprovider              │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53080  │         │ 1m5s   │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 52  │ sciencemesh-token-handler    │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53042  │         │ 1m6s   │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 91  │ NATS CLI Version development │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53162  │         │ 0s     │ 1       │ 0        │ 254 B    │ 0 B       │ 1    │
│ 86  │ ffa64:1:_ocis:reg            │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 172.18.0.7:53946 │         │ 36s    │ 3       │ 3        │ 4.0 KiB  │ 1.1 KiB   │ 1    │
│ 51  │ f0895:13:_ocis:reg           │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53040  │         │ 1m6s   │ 4       │ 4        │ 1.5 KiB  │ 1.1 KiB   │ 1    │
│ 56  │ f0895:13:storage-users:bus   │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53064  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 49  │ f0895:13:sse:bus             │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53036  │         │ 1m6s   │ 3       │ 3        │ 283 B    │ 1.6 KiB   │ 2    │
│ 55  │ f0895:13:userlog:bus         │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53054  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 53  │ f0895:13:postprocessing:bus  │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53052  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 59  │ jsoncs3-share-manager        │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53076  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 61  │ dataprovider                 │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53082  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 50  │ f0895:13:graph:bus           │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53038  │         │ 1m6s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 54  │ f0895:13:eventhistory:bus    │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53056  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 47  │ f0895:13:clientlog:bus       │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53028  │         │ 1m6s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 67  │ f0895:13:notifications:bus   │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53100  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 68  │ f0895:13:frontend:bus        │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53102  │         │ 1m5s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 80  │ b27d7:1:_ocis:reg            │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 172.18.0.6:35196 │         │ 36s    │ 10      │ 122      │ 2.9 KiB  │ 79 KiB    │ 2    │
│ 85  │ ffa64:1:search:bus           │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 172.18.0.7:53944 │         │ 36s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 45  │ f0895:13:activitylog:bus     │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53026  │         │ 1m6s   │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 35  │ f0895:13:_ocis:reg           │ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │ 127.0.0.1:53016  │         │ 1m7s   │ 123     │ 644      │ 102 KiB  │ 419 KiB   │ 6    │
├─────┼──────────────────────────────┼──────────────────────────────────────────────────────────┼──────────────┼──────────────────┼─────────┼────────┼─────────┼──────────┼──────────┼───────────┼──────┤
│     │ TOTALS FOR 24 CONNECTIONS    │                                                          │              │                  │         │        │ 180     │ 812      │ 111 KIB  │ 520 KIB   │ 37   │
╰─────┴──────────────────────────────┴──────────────────────────────────────────────────────────┴──────────────┴──────────────────┴─────────┴────────┴─────────┴──────────┴──────────┴───────────┴──────╯

╭───────────────────────────────────────────────────────────────────────────────────────╮
│                                 Connections per server                                │
├──────────────────────────────────────────────────────────┬──────────────┬─────────────┤
│ Server                                                   │ Cluster      │ Connections │
├──────────────────────────────────────────────────────────┼──────────────┼─────────────┤
│ NDGAWWVGUZNVZPI527FQBXUEEA73PCFLVNTB5LNO7773UKHQMAZJXHFS │ ocis-cluster │          24 │
╰──────────────────────────────────────────────────────────┴──────────────┴─────────────╯

There are some exceptions:

Some reva services generate their own connections and ocis cannot change them:
- storageprovider
- sciencemesh-token-handler
- jsoncs3-share-manager
- dataprovider
initial connection seems to come from

ocis/ocis/pkg/runtime/service/service.go

Line 523 in 626d78b

func pingNats(cfg *ociscfg.Config) error {

. It needs further investigation, so no changes for now.
There are no key-value / store connections. They're expected to be named with TODO according to https://github.com/cs3org/reva/blob/edge/pkg/store/store.go#L120-L138 , but they require reva changes in order to be able to change the name from ocis. We can't do anything about it for now.
NATS CLI Version development can be ignored because it comes from the command line executing the actual command.

Related Issue

#9594

Motivation and Context

It provides easier identification of which services or processes are accessing nats.

How Has This Been Tested?

Manually tested on an idle environment using the "official" nats client with the command shown above

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Technical debt
Tests only (no source changes)

Checklist:

Code changes
Unit tests added
Acceptance tests added
Documentation ticket raised:

Note: there are 2 f0895:13:_ocis:reg connections when there should be only one. We need to check where the other one comes from.

update-docs · 2025-03-18T18:03:57Z

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

2403905

The PR looks good to me.

jvillafanez · 2025-03-19T13:43:03Z

Final connection names below.

╭───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│                                                                                  Top 24 Connections out of 24 by subs                                                                                 │
├─────┬──────────────────────────────┬──────────────────────────────────────────────────────────┬──────────────┬──────────────────┬─────────┬────────┬─────────┬──────────┬──────────┬───────────┬──────┤
│ CID │ Name                         │ Server                                                   │ Cluster      │ IP               │ Account │ Uptime │ In Msgs │ Out Msgs │ In Bytes │ Out Bytes │ Subs │
├─────┼──────────────────────────────┼──────────────────────────────────────────────────────────┼──────────────┼──────────────────┼─────────┼────────┼─────────┼──────────┼──────────┼───────────┼──────┤
│ 54  │ 9b8a1:14:proxy:bus           │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44680  │         │ 41s    │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 64  │ 9b8a1:14:sharing:bus         │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44718  │         │ 41s    │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 63  │ sciencemesh-token-handler    │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44712  │         │ 41s    │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 62  │ 9b8a1:14:storage-users:bus   │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44714  │         │ 41s    │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 56  │ storageprovider              │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44684  │         │ 41s    │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 34  │ initial                      │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44642  │         │ 42s    │ 0       │ 0        │ 0 B      │ 0 B       │ 0    │
│ 88  │ NATS CLI Version development │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44778  │         │ 0s     │ 1       │ 0        │ 254 B    │ 0 B       │ 1    │
│ 82  │ 6beae:1:_ocis:reg            │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 172.20.0.6:53826 │         │ 11s    │ 2       │ 2        │ 2.0 KiB  │ 1.0 KiB   │ 1    │
│ 47  │ 9b8a1:14:_go-micro:reg       │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44658  │         │ 42s    │ 3       │ 3        │ 1.0 KiB  │ 1.0 KiB   │ 1    │
│ 55  │ dataprovider                 │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44686  │         │ 41s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 48  │ 9b8a1:14:clientlog:bus       │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44660  │         │ 41s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 52  │ 9b8a1:14:storage-users:bus   │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44672  │         │ 41s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 51  │ 9b8a1:14:activitylog:bus     │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44666  │         │ 41s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 50  │ 9b8a1:14:sse:bus             │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44664  │         │ 41s    │ 3       │ 3        │ 283 B    │ 1.6 KiB   │ 2    │
│ 61  │ jsoncs3-share-manager        │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44710  │         │ 41s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 49  │ 9b8a1:14:graph:bus           │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44668  │         │ 41s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 53  │ 9b8a1:14:postprocessing:bus  │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44682  │         │ 41s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 46  │ 9b8a1:14:userlog:bus         │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44652  │         │ 42s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 67  │ 9b8a1:14:notifications:bus   │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44734  │         │ 40s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 68  │ 9b8a1:14:frontend:bus        │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44730  │         │ 40s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 81  │ 6beae:1:search:bus           │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 172.20.0.6:53824 │         │ 11s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 45  │ 9b8a1:14:eventhistory:bus    │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44650  │         │ 42s    │ 3       │ 3        │ 24 B     │ 1.6 KiB   │ 2    │
│ 83  │ c1793:1:_ocis:reg            │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 172.20.0.7:33280 │         │ 10s    │ 8       │ 83       │ 1.8 KiB  │ 42 KiB    │ 2    │
│ 35  │ 9b8a1:14:_ocis:reg           │ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │ 127.0.0.1:44644  │         │ 42s    │ 86      │ 382      │ 68 KiB   │ 233 KiB   │ 5    │
├─────┼──────────────────────────────┼──────────────────────────────────────────────────────────┼──────────────┼──────────────────┼─────────┼────────┼─────────┼──────────┼──────────┼───────────┼──────┤
│     │ TOTALS FOR 24 CONNECTIONS    │                                                          │              │                  │         │        │ 139     │ 509      │ 74 KIB   │ 298 KIB   │ 36   │
╰─────┴──────────────────────────────┴──────────────────────────────────────────────────────────┴──────────────┴──────────────────┴─────────┴────────┴─────────┴──────────┴──────────┴───────────┴──────╯

╭───────────────────────────────────────────────────────────────────────────────────────╮
│                                 Connections per server                                │
├──────────────────────────────────────────────────────────┬──────────────┬─────────────┤
│ Server                                                   │ Cluster      │ Connections │
├──────────────────────────────────────────────────────────┼──────────────┼─────────────┤
│ NDXUY4G3JJPBOR4RCAZDY3WWPZON5TUYGP4DXAZRDLDXAOW7IJVW43IX │ ocis-cluster │          24 │
╰──────────────────────────────────────────────────────────┴──────────────┴─────────────╯

We might need alternatives to the "initial" connection. Despite the unused variable / pointer, it seems something is holding the connection open, and I don't think we can close the stream naturally (I just see Publish and Consume methods, but no Close or similar).
(https://github.com/owncloud/ocis/blob/master/ocis/pkg/runtime/service/service.go#L523-L528)

The rest of the connections require changes in reva, so we can skip those for the short term.

Good to merge from my side.

sonarqubecloud · 2025-04-01T13:03:48Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.8% Duplication on New Code

See analysis details on SonarQube Cloud

Nats connection names

jvillafanez self-assigned this Mar 18, 2025

2403905 approved these changes Mar 19, 2025

View reviewed changes

jvillafanez added 6 commits April 1, 2025 14:49

feat: use names for connections to the nats event bus

62f5228

feat: change the names of the connections to the registry

eb900a6

chore: add comments to new functions

37b064e

chore: change constant name to camelcase

f4644a6

fix: distinguish between go-micro and ocis connections to registry

c9ba3b9

chore: add missing comments

4e42eab

jvillafanez force-pushed the nats_connection_names branch from ae63410 to 4e42eab Compare April 1, 2025 12:49

jvillafanez merged commit 8abc02c into master Apr 1, 2025
4 checks passed

jvillafanez deleted the nats_connection_names branch April 1, 2025 13:28

ownclouders pushed a commit that referenced this pull request Apr 1, 2025

Merge pull request #11144 from owncloud/nats_connection_names

e08fbbe

Nats connection names

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Nats connection names #11144

Nats connection names #11144

jvillafanez commented Mar 18, 2025

update-docs bot commented Mar 18, 2025

2403905 left a comment

jvillafanez commented Mar 19, 2025 •

edited

Loading

sonarqubecloud bot commented Apr 1, 2025

Nats connection names #11144

Nats connection names #11144

Conversation

jvillafanez commented Mar 18, 2025

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

update-docs bot commented Mar 18, 2025

2403905 left a comment

Choose a reason for hiding this comment

jvillafanez commented Mar 19, 2025 • edited Loading

sonarqubecloud bot commented Apr 1, 2025

Quality Gate passed

jvillafanez commented Mar 19, 2025 •

edited

Loading