Chapter 237. Nagios Component
Available as of Camel version 2.3
The Nagios component allows you to send passive checks to Nagios.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-nagios</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>237.1. URI format
nagios://host[:port][?Options]
Camel provides two abilities with the Nagios component. You can send passive check messages by sending a message to its endpoint.
Camel also provides a EventNotifer which allows you to send notifications to Nagios.
237.2. Options
The Nagios component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| configuration (advanced) | To use a shared NagiosConfiguration | NagiosConfiguration | |
| resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The Nagios endpoint is configured using URI syntax:
nagios:host:port
with the following path and query parameters:
237.2.1. Path Parameters (2 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| host | Required This is the address of the Nagios host where checks should be send. | String | |
| port | Required The port number of the host. | int |
237.2.2. Query Parameters (7 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| connectionTimeout (producer) | Connection timeout in millis. | 5000 | int |
| sendSync (producer) | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. | true | boolean |
| timeout (producer) | Sending timeout in millis. | 5000 | int |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
| encryption (security) | To specify an encryption method. | Encryption | |
| encryptionMethod (security) | Deprecated To specify an encryption method. | NagiosEncryptionMethod | |
| password (security) | Password to be authenticated when sending checks to Nagios. | String |
237.3. Spring Boot Auto-Configuration
The component supports 10 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.nagios.configuration.connection-timeout | Connection timeout in millis. | 5000 | Integer |
| camel.component.nagios.configuration.encryption | To specify an encryption method. | Encryption | |
| camel.component.nagios.configuration.host | This is the address of the Nagios host where checks should be send. | String | |
| camel.component.nagios.configuration.nagios-settings | NagiosSettings | ||
| camel.component.nagios.configuration.password | Password to be authenticated when sending checks to Nagios. | String | |
| camel.component.nagios.configuration.port | The port number of the host. | Integer | |
| camel.component.nagios.configuration.timeout | Sending timeout in millis. | 5000 | Integer |
| camel.component.nagios.enabled | Enable nagios component | true | Boolean |
| camel.component.nagios.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
| camel.component.nagios.configuration.encryption-method | To specify an encryption method. | NagiosEncryptionMethod |
237.4. Sending message examples
You can send a message to Nagios where the message payload contains the message. By default it will be OK level and use the CamelContext name as the service name. You can overrule these values using headers as shown above.
For example we send the Hello Nagios message to Nagios as follows:
template.sendBody("direct:start", "Hello Nagios");
from("direct:start").to("nagios:127.0.0.1:5667?password=secret").to("mock:result");
To send a CRITICAL message you can send the headers such as:
Map headers = new HashMap();
headers.put(NagiosConstants.LEVEL, "CRITICAL");
headers.put(NagiosConstants.HOST_NAME, "myHost");
headers.put(NagiosConstants.SERVICE_NAME, "myService");
template.sendBodyAndHeaders("direct:start", "Hello Nagios", headers);237.5. Using NagiosEventNotifer
The Nagios component also provides an EventNotifer which you can use to send events to Nagios. For example we can enable this from Java as follows:
NagiosEventNotifier notifier = new NagiosEventNotifier();
notifier.getConfiguration().setHost("localhost");
notifier.getConfiguration().setPort(5667);
notifier.getConfiguration().setPassword("password");
CamelContext context = ...
context.getManagementStrategy().addEventNotifier(notifier);
return context;
In Spring XML its just a matter of defining a Spring bean with the type EventNotifier and Camel will pick it up as documented here: Advanced configuration of CamelContext using Spring.
237.6. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
