API Action "remove-downtime": Also remove child downtimes by N-o-X · Pull Request #8913 · Icinga/icinga2

N-o-X · 2021-07-20T14:08:06Z

This PR adds the attribute parent to the Downtime object. This allows us to delete downtimes that have been created as child downtimes on a hosts services (using API parameter all_services) while deleting the hosts downtime.

Attribute PR in Icinga DB (used for testing): Icinga/icingadb#323

Testing

Config

var serviceCount = 3

object Host "DowntimeTestHost" {
        check_command = "dummy"
}

for (s in range(serviceCount)) {
        object Service "DowntimeTestService-" + s {
                check_command = "dummy"
                host_name = "DowntimeTestHost"
        }
}

Steps

Schedule downtimes with all_services option:

curl -k -s -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5665/v1/actions/schedule-downtime' \
 -d '{ "type": "Host", "filter": "host.name==\"DowntimeTestHost\"", "start_time": 1446388806, "end_time": 1746389806, "author": "icingaadmin", "comment": "test", "pretty": true, "all_services": true }'

Select all downtimes from Icinga DB database:

mysql icingadb -e "select id, parent_id, object_type from downtime order by object_type;"

Delete parent downtime:

curl -k -s -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5665/v1/actions/remove-downtime' \
 -d '{ "downtime": "<DOWNTIME-NAME>", "pretty": true }'

Again select all downtimes from Icinga DB database to validate the removal of all services downtimes:

mysql icingadb -e "select id, parent_id, object_type from downtime order by object_type;"

Results

Before

Create downtimes

[noah@NoH-MB ~ ]$ curl -k -s -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5665/v1/actions/schedule-downtime' \
 -d '{ "type": "Host", "filter": "host.name==\"DowntimeTestHost\"", "start_time": 1446388806, "end_time": 1746389806, "author": "icingaadmin", "comment": "test", "pretty": true, "all_services": true }'
{
    "results": [
        {
            "code": 200,
            "legacy_id": 1,
            "name": "DowntimeTestHost!b6ad0a3b-7c8f-4a2c-968e-dc0e8fbda103",
            "service_downtimes": [
                {
                    "legacy_id": 2,
                    "name": "DowntimeTestHost!DowntimeTestService-0!58a333db-13cf-43e4-9f8b-22f60d8b3c91"
                },
                {
                    "legacy_id": 3,
                    "name": "DowntimeTestHost!DowntimeTestService-1!4dd12ad7-3b0d-49b4-b575-f81a09f694b1"
                },
                {
                    "legacy_id": 4,
                    "name": "DowntimeTestHost!DowntimeTestService-2!fb172915-0ab9-44bf-92c2-232d41b18b0e"
                }
            ],
            "status": "Successfully scheduled downtime 'DowntimeTestHost!b6ad0a3b-7c8f-4a2c-968e-dc0e8fbda103' for object 'DowntimeTestHost'."
        }
    ]
}

Select from Icinga DB database

[noah@NoH-MB ~ ]$ mysql icingadb -e "select id, object_type from downtime order by object_type;"
+--------------------------------------------+-------------+
| id                                         | object_type |
+--------------------------------------------+-------------+
| 0x1498918DDF6288BCCAA8885C48950272915149ED | host        |
| 0x31CA087DCFAE8A312FF773B13923A2E314EB3685 | service     |
| 0x9A0426DBC927DC8E4188FE0DEB7344349DF2BC3E | service     |
| 0xE8427CECB1E2652403E73E8A52A9D40A41ADB32A | service     |
+--------------------------------------------+-------------+

Remove parent downtime

[noah@NoH-MB ~ ]$ curl -k -s -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5665/v1/actions/remove-downtime' \
 -d '{ "downtime": "DowntimeTestHost!b6ad0a3b-7c8f-4a2c-968e-dc0e8fbda103", "pretty": true }'
{
    "results": [
        {
            "code": 200,
            "status": "Successfully removed downtime 'DowntimeTestHost!b6ad0a3b-7c8f-4a2c-968e-dc0e8fbda103'."
        }
    ]
}

Again select all services from Icinga DB database:

[noah@NoH-MB ~ ]$ mysql icingadb -e "select id, object_type from downtime order by object_type;"
+--------------------------------------------+-------------+
| id                                         | object_type |
+--------------------------------------------+-------------+
| 0x31CA087DCFAE8A312FF773B13923A2E314EB3685 | service     |
| 0x9A0426DBC927DC8E4188FE0DEB7344349DF2BC3E | service     |
| 0xE8427CECB1E2652403E73E8A52A9D40A41ADB32A | service     |
+--------------------------------------------+-------------+
// Service downtimes are still there

After

Create downtimes

[noah@NoH-MB ~ ]$ curl -k -s -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5665/v1/actions/schedule-downtime' \
 -d '{ "type": "Host", "filter": "host.name==\"DowntimeTestHost\"", "start_time": 1446388806, "end_time": 1746389806, "author": "icingaadmin", "comment": "test", "pretty": true, "all_services": true }'
{
    "results": [
        {
            "code": 200,
            "legacy_id": 1,
            "name": "DowntimeTestHost!e26a4f56-63cd-4388-8975-2db0d8fc8107",
            "service_downtimes": [
                {
                    "legacy_id": 2,
                    "name": "DowntimeTestHost!DowntimeTestService-0!57b60fd9-4cb7-493a-b33d-ef892aacf7b8"
                },
                {
                    "legacy_id": 3,
                    "name": "DowntimeTestHost!DowntimeTestService-1!d2e7793d-db42-40fa-88c2-6ab78f5c823e"
                },
                {
                    "legacy_id": 4,
                    "name": "DowntimeTestHost!DowntimeTestService-2!72393c64-201d-407c-8bdc-396f1601ed0e"
                }
            ],
            "status": "Successfully scheduled downtime 'DowntimeTestHost!e26a4f56-63cd-4388-8975-2db0d8fc8107' for object 'DowntimeTestHost'."
        }
    ]
}

Select from Icinga DB database (should see parent_id set to the hosts downtime id)

[noah@NoH-MB ~ ]$ mysql icingadb -e "select id, parent_id, object_type from downtime order by object_type;"
+--------------------------------------------+--------------------------------------------+-------------+
| id                                         | parent_id                                  | object_type |
+--------------------------------------------+--------------------------------------------+-------------+
| 0x1ECE86DE1B6BB9D98222123E7F61059A3EBD4DDF | NULL                                       | host        |
| 0x348EDE862D53874FACAFFE3F71F26584ECF61C28 | 0x1ECE86DE1B6BB9D98222123E7F61059A3EBD4DDF | service     |
| 0x437A5875F7956B16D5AA4ED401540108FC7802EF | 0x1ECE86DE1B6BB9D98222123E7F61059A3EBD4DDF | service     |
| 0xDDBD7297C7B149C58D8D24112E56DD002EC39767 | 0x1ECE86DE1B6BB9D98222123E7F61059A3EBD4DDF | service     |
+--------------------------------------------+--------------------------------------------+-------------+

Remove parent downtime

[noah@NoH-MB ~ ]$ curl -k -s -u root:icinga -H 'Accept: application/json' \
 -X POST 'https://localhost:5665/v1/actions/remove-downtime' \
 -d '{ "downtime": "DowntimeTestHost!e26a4f56-63cd-4388-8975-2db0d8fc8107", "pretty": true }'
{
    "results": [
        {
            "code": 200,
            "status": "Successfully removed downtime 'DowntimeTestHost!e26a4f56-63cd-4388-8975-2db0d8fc8107' and 3 child downtimes."
        }
    ]
}

Again select all services from Icinga DB database:

[noah@NoH-MB ~ ]$ mysql icingadb -e "select id, parent_id, object_type from downtime order by object_type;"
[noah@NoH-MB ~ ]$
// Emtpy result set -> All child downtimes have been removed

julianbrost · 2021-07-20T14:18:13Z

Why not have each downtime keep track of its child/service downtimes, similar to how a checkable keeps track of its downtimes (Checkable::GetDowntimes()). This would eliminate the need for having to store an explicit attribute has_child_downtimes and then actively search for these on deletion.

Al2Klimov

What’s the use case for not deleting children?
Why don’t let Downtimes disappear à la the scheduled ones?

Al2Klimov

LGTM in general, but...

Al2Klimov · 2021-07-27T10:00:25Z

lib/icinga/apiactions.cpp

+
 			try {
-				Downtime::RemoveDowntime(downtime->GetName(), true);
+				Downtime::RemoveDowntime(downtime->GetName(), true, true);


Why here true...

Al2Klimov · 2021-07-27T10:00:49Z

lib/icinga/externalcommandprocessor.cpp


 	try {
-		Downtime::RemoveDowntime(rid, true);
+		Downtime::RemoveDowntime(rid, false, true);


... but here and below false?

Because I didn't want to touch anything, but the behavior of the API action. If we add it here, we would also need to change the behavior of downtime creation via the external command processor.

Al2Klimov

Fine.

Services downtimes scheduled via the `all_services` parameter already Services downtimes scheduled via the `all_services` flag get already removed automatically when removing their parent downtimes (introduced with #8913). Now, this commit makes it possible to perform the same actions for all child downtimes, i.e. not only for those of service objects, but for all child objects represented in the dependency tree.

Services downtimes scheduled via the `all_services` flag get already removed automatically when removing their parent downtimes (introduced with #8913). Now, this commit makes it possible to perform the same actions for all child downtimes, i.e. not only for those of service objects, but for all child objects represented in the dependency tree.

N-o-X added enhancement New feature or request area/api REST API area/runtime Downtimes, comments, dependencies, events labels Jul 20, 2021

N-o-X added this to the 2.13.0 milestone Jul 20, 2021

N-o-X force-pushed the feature/remove-child-downtimes branch 2 times, most recently from 0d7af54 to d936776 Compare July 22, 2021 15:43

N-o-X mentioned this pull request Jul 22, 2021

Downtime: Add parent_id Icinga/icingadb#323

Merged

N-o-X marked this pull request as ready for review July 22, 2021 15:49

N-o-X requested review from Al2Klimov and lippserd July 22, 2021 15:51

API Action 'remove-downtime': Also remove child downtimes

7217959

N-o-X force-pushed the feature/remove-child-downtimes branch from d936776 to 7217959 Compare July 23, 2021 11:53

lippserd approved these changes Jul 26, 2021

View reviewed changes

Al2Klimov reviewed Jul 26, 2021

View reviewed changes

Al2Klimov reviewed Jul 27, 2021

View reviewed changes

Al2Klimov approved these changes Jul 27, 2021

View reviewed changes

N-o-X merged commit 07145d2 into master Jul 27, 2021

N-o-X deleted the feature/remove-child-downtimes branch July 27, 2021 16:02

julianbrost mentioned this pull request Sep 3, 2021

Fix scheduling of downtimes for all services on child hosts #8990

Merged

julianbrost mentioned this pull request Apr 19, 2022

Bug in 2.12.7 release related to downtimes for all services on child hosts #9345

Closed

Al2Klimov mentioned this pull request Mar 23, 2023

WIP: API/Downtimes: Generate sequence ID for child_options/all_services and document filtered removal #7234

Closed

nilmerg mentioned this pull request Feb 9, 2024

Usage of IcingaWeb2 api command returns 404, but is successful Icinga/icingaweb2#5183

Closed

yhabteab mentioned this pull request Feb 5, 2025

ApiActions: Remove child downtimes recursively #10345

Merged

Al2Klimov mentioned this pull request May 7, 2025

Remove deprecated features: compatlog, commandpipe #6307

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API Action "remove-downtime": Also remove child downtimes#8913

API Action "remove-downtime": Also remove child downtimes#8913
N-o-X merged 1 commit intomasterfrom
feature/remove-child-downtimes

N-o-X commented Jul 20, 2021 •

edited

Loading

Uh oh!

julianbrost commented Jul 20, 2021

Uh oh!

Al2Klimov left a comment

Uh oh!

Al2Klimov left a comment

Uh oh!

Al2Klimov Jul 27, 2021

Uh oh!

Al2Klimov Jul 27, 2021

Uh oh!

N-o-X Jul 27, 2021

Uh oh!

Al2Klimov left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

N-o-X commented Jul 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

Config

Steps

Results

Before

After

Uh oh!

julianbrost commented Jul 20, 2021

Uh oh!

Al2Klimov left a comment

Choose a reason for hiding this comment

Uh oh!

Al2Klimov left a comment

Choose a reason for hiding this comment

Uh oh!

Al2Klimov Jul 27, 2021

Choose a reason for hiding this comment

Uh oh!

Al2Klimov Jul 27, 2021

Choose a reason for hiding this comment

Uh oh!

N-o-X Jul 27, 2021

Choose a reason for hiding this comment

Uh oh!

Al2Klimov left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

N-o-X commented Jul 20, 2021 •

edited

Loading