API: /api/shovels/{vhost}/{name} is not returning the status

[Cath1120]

Community Support Policy

• I have read RabbitMQ's Community Support Policy
• I agree to provide all relevant information (versions, logs, rabbitmq-diagnostics output, detailed reproduction steps)

RabbitMQ version used

3.13.7

Erlang version used

26.2.x

What problem are you trying to solve?

I am not able to retrieve the status of a specific shovel with rabbitmq version 3.13.7

curl -u user:password http://localhost:15672/api/shovels/vhost/%2f/my_shovel | jq

{
"value": {
"ack-mode": "on-publish",
"add-forward-headers": false,
"delete-after": "never",
"dest-exchange": "XXXXX",
"dest-uri": [
"amqps://XXX:[email protected]:5671/%2F?verify=verify_none"
],
"src-queue": "XXXXX",
"src-uri": [
"amqp://"
]
},
"vhost": "/",
"component": "shovel",
"name": "my_shovel"
}

[mkuratczyk]

This looks perfectly good to me.

> rabbitmqctl set_parameter shovel myshovel1 '{"src-protocol": "amqp091", "src-uri": "amqp://localhost", "src-queue": "source1", "dest-protocol": "amqp10", "dest-uri": "amqp://localhost", "dest-address": "/queue/destination1"}'
Setting runtime parameter "myshovel1" for component "shovel" to "{"src-protocol": "amqp091", "src-uri": "amqp://localhost", "src-queue": "source1", "dest-protocol": "amqp10", "dest-uri": "amqp://localhost", "dest-address": "/queue/destination1"}" in vhost "/" ...

> rabbitmqctl set_parameter shovel myshovel2 '{"src-protocol": "amqp091", "src-uri": "amqp://localhost", "src-queue": "source2", "dest-protocol": "amqp10", "dest-uri": "amqp://localhost", "dest-address": "/queue/destination2"}'
Setting runtime parameter "myshovel2" for component "shovel" to "{"src-protocol": "amqp091", "src-uri": "amqp://localhost", "src-queue": "source2", "dest-protocol": "amqp10", "dest-uri": "amqp://localhost", "dest-address": "/queue/destination2"}" in vhost "/" ...

> curl -s -q -u guest:guest -X GET 'http://localhost:15672/api/shovels/vhost/%2F/myshovel1' | jq
{
  "value": {
    "dest-address": "/queue/destination1",
    "dest-protocol": "amqp10",
    "dest-uri": "amqp://localhost",
    "src-protocol": "amqp091",
    "src-queue": "source1",
    "src-uri": "amqp://localhost"
  },
  "vhost": "/",
  "component": "shovel",
  "name": "myshovel1"
}

> curl -s -q -u guest:guest -X GET 'http://localhost:15672/api/shovels/vhost/%2F/myshovel2' | jq
{
  "value": {
    "dest-address": "/queue/destination2",
    "dest-protocol": "amqp10",
    "dest-uri": "amqp://localhost",
    "src-protocol": "amqp091",
    "src-queue": "source2",
    "src-uri": "amqp://localhost"
  },
  "vhost": "/",
  "component": "shovel",
  "name": "myshovel2"
}

> curl -s -q -u guest:guest -X GET 'http://localhost:15672/api/shovels/' | jq
[
  {
    "node": "rabbit@K6L59PF0JR",
    "timestamp": "2024-10-25 11:16:27",
    "name": "myshovel1",
    "vhost": "/",
    "type": "dynamic",
    "state": "running",
    "src_uri": "amqp://localhost",
    "src_protocol": "amqp091",
    "dest_protocol": "amqp10",
    "dest_uri": "amqp://localhost",
    "src_queue": "source1",
    "dest_address": "/queue/destination1",
    "blocked_status": "running"
  },
  {
    "node": "rabbit@K6L59PF0JR",
    "timestamp": "2024-10-25 11:16:39",
    "name": "myshovel2",
    "vhost": "/",
    "type": "dynamic",
    "state": "running",
    "src_uri": "amqp://localhost",
    "src_protocol": "amqp091",
    "dest_protocol": "amqp10",
    "dest_uri": "amqp://localhost",
    "src_queue": "source2",
    "dest_address": "/queue/destination2",
    "blocked_status": "running"
  }
]

The first two calls return the details of a specific shovel. The last call returns a list of all shovels.

[Cath1120]

I would like to retrieve "state" of shovel when i point to api/shovels/vhost/%2F/myshovel1 to monitor the state of each shovel.
Is it not possible to get the "state" ?

[mkuratczyk]

I see. The best I can think of is this:

> curl -s -q -u guest:guest -X GET 'http://localhost:15672/api/shovels/?columns=name,state' | jq
[
  {
    "name": "myshovel1",
    "state": "running"
  },
  {
    "name": "myshovel2",
    "state": "running"
  }
]

[Cath1120]

Thank you for your reply.
Do you think that it is possible to add column "state" in this API /api/shovels/vhost/%2F/{shovel_name} in the future release ?

[michaelklishin]

@Cath1120 you are welcome to add it. RabbitMQ is open source software and rabbitmq_shovel_management which provides the endpoint is a very small plugin.