add "series" event parameters when pinging cronitor hook #592

New issue

Closed

opened 2022-10-04 10:01:49 +00:00 by xLogiiCx · 6 comments

xLogiiCx commented 2022-10-04 10:01:49 +00:00

Copy link

What I'm trying to do and why

i noticed, that for each mode bormatic runs (prune, compact, create etc.) it sends a single ping to cronitor.
it would be a great addition if you also could add the "series" event parameter. it would improve the clarity enormously

Expected behavior

when sending a single ping to cronitor add the current running mode (prune,compact,create etc) as a "series" event parameter in the request.
e.g

curl https://cronitor.link/p/e981f5ece0f948e8be3e05abdb4cf3f8/nightly-job?state=run&series=prune

in my opinion the best way would be to be able to addd a custom "series" and add a variable which contains the current borg mode.

Environment

borgmatic version: 1.7.2

borgmatic installation method: aur

Borg version: 1.2.2

Python version: Python 3.10.7

operating system and version: Linux 5.19.12-arch1-1 x86_64

#### What I'm trying to do and why i noticed, that for each mode bormatic runs (prune, compact, create etc.) it sends a single ping to cronitor. it would be a great addition if you also could add the "series" [event parameter](https://cronitor.io/docs/telemetry-api#parameters). it would improve the clarity enormously #### Expected behavior when sending a single ping to cronitor add the current running mode (prune,compact,create etc) as a "series" event parameter in the request. e.g ``` curl https://cronitor.link/p/e981f5ece0f948e8be3e05abdb4cf3f8/nightly-job?state=run&series=prune ``` in my opinion the best way would be to be able to addd a custom "series" and add a variable which contains the current borg mode. #### Environment **borgmatic version:** 1.7.2 **borgmatic installation method:** aur **Borg version:** 1.2.2 **Python version:** Python 3.10.7 **operating system and version:** Linux 5.19.12-arch1-1 x86_64

witten commented 2022-10-04 22:31:56 +00:00

Owner

Copy link

Interesting! I didn't know Cronitor supported this. Would this series support be preferable to a feature like #518 (separate ping URLs per borgmatic action)? Or would you potentially take advantage of both?

Interesting! I didn't know Cronitor supported this. Would this `series` support be preferable to a feature like #518 (separate ping URLs per borgmatic action)? Or would you potentially take advantage of both?

xLogiiCx commented 2022-10-06 18:25:17 +00:00

Author

Copy link

I like both Ideas.

Then you could decide if you use them in a Single Check and keep the different options appart with the "series" support.
Or you could create different task with the #518 Idea to get a better overview of the duration of the single commands for example.

I like both Ideas. Then you could decide if you use them in a Single Check and keep the different options appart with the "series" support. Or you could create different task with the #518 Idea to get a better overview of the duration of the single commands for example.

witten commented 2022-10-12 17:27:26 +00:00

Owner

Copy link

That makes sense to me!

That makes sense to me!

witten referenced this issue 2022-10-27 16:24:45 +00:00

Hook "on_warning" #606

witten added the

good first issue

label 2023-02-04 17:17:09 +00:00

witten commented 2024-07-08 02:30:43 +00:00

Owner

Copy link

I know this ticket has been languishing a while, but now I have a question on it, assuming this feature is still of interest to you: borgmatic usually runs with multiple actions (e.g. create, prune, etc.), and only pings Cronitor with a single start/finish pair for all of those actions rather than each of them. You can optionally run borgmatic with a single action, but that's not the default. So what would be a useful value for series in the case when multiple actions are being run? Would that even be helpful, or would it defeat the purpose of this proposed feature?

I assume that when you filed this ticket, you were running borgmatic with individual actions, e.g. borgmatic create, borgmatic prune, etc...? And that's why you wanted to be able to distinguish the pings in Cronitor?

I know this ticket has been languishing a while, but now I have a question on it, assuming this feature is still of interest to you: borgmatic usually runs with multiple actions (e.g. `create`, `prune`, etc.), and only pings Cronitor with a single start/finish pair for all of those actions rather than each of them. You *can* optionally run borgmatic with a single action, but that's not the default. So what would be a useful value for `series` in the case when multiple actions are being run? Would that even be helpful, or would it defeat the purpose of this proposed feature? I assume that when you filed this ticket, you were running borgmatic with individual actions, e.g. `borgmatic create`, `borgmatic prune`, etc...? And that's why you wanted to be able to distinguish the pings in Cronitor?

witten commented 2024-07-08 02:34:01 +00:00

Owner

Copy link

An alternate proposal: Instead of putting the action(s) into series, borgmatic could just generate a unique ID specific to that borgmatic run and put it into series for both start and finish states. That would allow you to correlate pings within Cronitor even if it doesn't tell you the action(s) run.

An alternate proposal: Instead of putting the action(s) into `series`, borgmatic could just generate a unique ID specific to that borgmatic run and put it into `series` for both start and finish states. That would allow you to correlate pings within Cronitor even if it doesn't tell you the action(s) run.

witten removed the

good first issue

label 2024-07-08 02:34:10 +00:00

witten commented 2024-10-27 02:30:21 +00:00

Owner

Copy link

I'm closing this now due to inactivity, but I can certainly reopen it if you have feedback on the points above. Thank you!

I'm closing this now due to inactivity, but I can certainly reopen it if you have feedback on the points above. Thank you!

witten closed this issue 2024-10-27 02:30:21 +00:00

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

parallel-borgmatic

command-hook-steps

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.13

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

1.8.11

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels   

blocked

  

breaking

  

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No labels

blocked

breaking

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No milestone

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

borgmatic-collective/borgmatic#592

No description provided.