DSL: introduce on_config_committed #7460

Al2Klimov · 2019-08-29T15:45:29Z

Al2Klimov · 2019-08-29T16:02:41Z

Test protocol

PoC

`/etc/icinga2/conf.d/occ.conf`

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

log(LogCritical, "direct", get_object(Host, "occ"))

on_config_committed {
	log(LogCritical, "on_config_committed", get_object(Host, "occ"))
}

`icinga2 daemon -C`

[2019-08-29 17:47:23 +0200] information/cli: Icinga application loader (version: v2.11.0-rc1-91-gc029bfaa5; debug)
[2019-08-29 17:47:23 +0200] information/cli: Loading configuration file(s).
[2019-08-29 17:47:23 +0200] critical/direct:
[2019-08-29 17:47:23 +0200] information/ConfigItem: Committing config item(s).
[2019-08-29 17:47:23 +0200] information/ApiListener: My API identity: CENSORED
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 ApiListener.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 235 CheckCommands.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 NotificationComponent.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 FileLogger.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 ApiUser.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 Downtime.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 Endpoint.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 2 Hosts.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 2 HostGroups.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 IcingaApplication.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 12 Notifications.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 2 NotificationCommands.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 UserGroup.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 3 ServiceGroups.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 ScheduledDowntime.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 11 Services.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 3 Zones.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 3 TimePeriods.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 User.
[2019-08-29 17:47:24 +0200] information/ConfigItem: Instantiated 1 CheckerComponent.
[2019-08-29 17:47:24 +0200] critical/on_config_committed: Object of type 'Host'
[2019-08-29 17:47:24 +0200] information/ScriptGlobal: Dumping variables to file 'CENSORED/var/cache/icinga2/icinga2.vars'
[2019-08-29 17:47:24 +0200] information/cli: Finished validating the configuration file(s).

Nested sin

`/etc/icinga2/conf.d/occ.conf`

on_config_committed {
	on_config_committed {
	}
}

`icinga2 daemon -C`

[2019-08-29 17:50:29 +0200] information/cli: Icinga application loader (version: v2.11.0-rc1-91-gc029bfaa5; debug)
[2019-08-29 17:50:29 +0200] information/cli: Loading configuration file(s).
[2019-08-29 17:50:29 +0200] information/ConfigItem: Committing config item(s).
[2019-08-29 17:50:29 +0200] information/ApiListener: My API identity: CENSORED
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 ApiListener.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 235 CheckCommands.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 NotificationComponent.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 FileLogger.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 ApiUser.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 Downtime.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 Endpoint.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 Host.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 2 HostGroups.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 IcingaApplication.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 12 Notifications.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 2 NotificationCommands.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 UserGroup.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 3 ServiceGroups.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 ScheduledDowntime.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 11 Services.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 3 Zones.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 3 TimePeriods.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 User.
[2019-08-29 17:50:29 +0200] information/ConfigItem: Instantiated 1 CheckerComponent.
[2019-08-29 17:50:29 +0200] critical/config: Error: on_config_committed is not allowed after the config has been committed.
Location: in CENSORED/etc/icinga2/conf.d/occ.conf: 10:2-11:2
CENSORED/etc/icinga2/conf.d/occ.conf(8):
CENSORED/etc/icinga2/conf.d/occ.conf(9): on_config_committed {
CENSORED/etc/icinga2/conf.d/occ.conf(10):  on_config_committed {
                                                                       ^^^^^^^^^^^^^^^^^^^^^
CENSORED/etc/icinga2/conf.d/occ.conf(11):  }
                                                                      ^^
CENSORED/etc/icinga2/conf.d/occ.conf(12): }
CENSORED/etc/icinga2/conf.d/occ.conf(13):

[2019-08-29 17:50:29 +0200] critical/cli: Config validation failed. Re-run with 'icinga2 daemon -C' after fixing the config.

Runtime sin

`/etc/icinga2/conf.d/occ.conf`

object Host "occ" {
	check_command = "dummy"
	check_interval = 1s

	vars.dummy_text = function() {
		on_config_committed {
		}

		return "I has cheezburger!"
	}
}

`icinga2 daemon`

[2019-08-29 17:57:36 +0200] information/cli: Icinga application loader (version: v2.11.0-rc1-91-gc029bfaa5; debug)
[2019-08-29 17:57:36 +0200] information/cli: Loading configuration file(s).
[2019-08-29 17:57:36 +0200] information/ConfigItem: Committing config item(s).
[2019-08-29 17:57:36 +0200] information/ApiListener: My API identity: CENSORED
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 ApiListener.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 235 CheckCommands.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 NotificationComponent.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 FileLogger.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 ApiUser.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 Endpoint.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 2 Hosts.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 2 HostGroups.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 IcingaApplication.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 12 Notifications.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 2 NotificationCommands.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 UserGroup.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 3 ServiceGroups.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 ScheduledDowntime.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 11 Services.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 3 Zones.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 3 TimePeriods.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 User.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 CheckerComponent.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Instantiated 1 Downtime.
[2019-08-29 17:57:36 +0200] information/ScriptGlobal: Dumping variables to file 'CENSORED/var/cache/icinga2/icinga2.vars'
[2019-08-29 17:57:36 +0200] information/ConfigObject: Restoring program state from file 'CENSORED/var/lib/icinga2/icinga2.state'
[2019-08-29 17:57:36 +0200] information/ConfigObject: Restored 283 objects. Loaded 2 new objects without state.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Triggering Start signal for config items
[2019-08-29 17:57:36 +0200] information/FileLogger: 'main-log' started.
[2019-08-29 17:57:36 +0200] information/ApiListener: 'api' started.
[2019-08-29 17:57:36 +0200] information/ApiListener: Started new listener on '[::]:5665'
[2019-08-29 17:57:36 +0200] information/NotificationComponent: 'notification' started.
[2019-08-29 17:57:36 +0200] information/CheckerComponent: 'checker' started.
[2019-08-29 17:57:36 +0200] information/ConfigItem: Activated all objects.
[2019-08-29 17:57:36 +0200] critical/checker: Exception occurred while checking 'occ': Error: on_config_committed is not allowed after the config has been committed.
Location: in CENSORED/etc/icinga2/conf.d/occ.conf: 6:3-7:3
CENSORED/etc/icinga2/conf.d/occ.conf(4):
CENSORED/etc/icinga2/conf.d/occ.conf(5):  vars.dummy_text = function() {
CENSORED/etc/icinga2/conf.d/occ.conf(6):   on_config_committed {
                                                                       ^^^^^^^^^^^^^^^^^^^^^
CENSORED/etc/icinga2/conf.d/occ.conf(7):   }
                                                                     ^^^
CENSORED/etc/icinga2/conf.d/occ.conf(8):
CENSORED/etc/icinga2/conf.d/occ.conf(9):   return "I has cheezburger!"

	(0) Resolving macros for string '$dummy_text$'
	(1) Executing check for object 'occ'

^C[2019-08-29 17:57:40 +0200] information/Application: Received request to shut down.
[2019-08-29 17:57:40 +0200] information/Application: Shutting down...
[2019-08-29 17:57:40 +0200] information/CheckerComponent: 'checker' stopped.
[2019-08-29 17:57:40 +0200] information/NotificationComponent: 'notification' stopped.
[2019-08-29 17:57:40 +0200] information/ApiListener: 'api' stopped.
[2019-08-29 17:57:40 +0200] information/ConfigObject: Dumping program state to file 'CENSORED/var/lib/icinga2/icinga2.state'
[2019-08-29 17:57:40 +0200] information/IcingaApplication: Icinga has shut down.

dnsmichi · 2019-08-30T07:33:21Z

Incredibly beautiful ❤️ @lippserd @bobapple this will come handy for 2.12 as a PoC for a more specific implementation.

lippserd · 2021-03-08T12:18:35Z

Parsing / activating our configuration is already pretty slow. I would wait with this feature until we agreed that it is really necessary, as depending on how it is used, the whole process will very likely be slowed down further.

Al2Klimov · 2021-08-04T12:23:31Z

@cla-bot check

refs #3520

Al2Klimov · 2023-06-20T15:35:24Z

depending on how it is used, the whole process will very likely be slowed down further.

Absolutely, but

you don’t have to use it at all
yo can already slow down stuff if you really want to.

julianbrost · 2023-06-20T15:41:38Z

What would be the use-case for this? #3520 suggests it, but doesn't provide an example what this would be useful.

Al2Klimov · 2023-06-20T15:47:01Z

I guess only the OP (@lippserd) knows.

Al2Klimov · 2023-08-29T15:59:20Z

This forum thread seems to need this feature:

https://community.icinga.com/t/apply-rules-for-hosts-mixing-director-and-static-files/12393/2

Al2Klimov requested a review from dnsmichi August 29, 2019 15:45

dnsmichi added area/configuration DSL, parser, compiler, error handling enhancement New feature or request TBD To be defined - We aren't certain about this yet labels Aug 30, 2019

dnsmichi added this to the 2.12.0 milestone Sep 2, 2019

dnsmichi modified the milestones: 2.12.0, 2.13.0 Oct 22, 2019

dnsmichi added this to Design Drafts in icinga2 Nov 15, 2019

Al2Klimov requested review from N-o-X and removed request for dnsmichi November 18, 2019 12:31

dnsmichi requested a review from lippserd November 18, 2019 16:32

Al2Klimov added this to To review in v2.13.0 merge window Mar 12, 2020

lippserd removed this from the 2.13.0 milestone Mar 8, 2021

lippserd removed this from To review in v2.13.0 merge window Mar 8, 2021

lippserd removed request for N-o-X and lippserd March 8, 2021 12:19

cla-bot bot added the cla/signed label Aug 4, 2021

Al2Klimov added this to unsorted in 42 quadrillions PRs Aug 10, 2021

Al2Klimov moved this from unsorted to awaits concept review (i.e. TBD) in 42 quadrillions PRs Aug 10, 2021

DSL: introduce on_config_committed

35c58d1

refs #3520

Al2Klimov force-pushed the feature/on_config_committed-3520 branch from cffb77a to 35c58d1 Compare May 17, 2023 15:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DSL: introduce on_config_committed #7460

DSL: introduce on_config_committed #7460

Al2Klimov commented Aug 29, 2019

Al2Klimov commented Aug 29, 2019

dnsmichi commented Aug 30, 2019

lippserd commented Mar 8, 2021

Al2Klimov commented Aug 4, 2021

Al2Klimov commented Jun 20, 2023

julianbrost commented Jun 20, 2023

Al2Klimov commented Jun 20, 2023

Al2Klimov commented Aug 29, 2023

DSL: introduce on_config_committed #7460

Are you sure you want to change the base?

DSL: introduce on_config_committed #7460

Conversation

Al2Klimov commented Aug 29, 2019

Al2Klimov commented Aug 29, 2019

Test protocol

PoC

/etc/icinga2/conf.d/occ.conf

icinga2 daemon -C

Nested sin

/etc/icinga2/conf.d/occ.conf

icinga2 daemon -C

Runtime sin

/etc/icinga2/conf.d/occ.conf

icinga2 daemon

dnsmichi commented Aug 30, 2019

lippserd commented Mar 8, 2021

Al2Klimov commented Aug 4, 2021

Al2Klimov commented Jun 20, 2023

julianbrost commented Jun 20, 2023

Al2Klimov commented Jun 20, 2023

Al2Klimov commented Aug 29, 2023

`/etc/icinga2/conf.d/occ.conf`

`icinga2 daemon -C`

`/etc/icinga2/conf.d/occ.conf`

`icinga2 daemon -C`

`/etc/icinga2/conf.d/occ.conf`

`icinga2 daemon`