Integrating with Naemon

You can view the collected data in various BMC Helix applications and derive the following benefits:

As a tenant administrator, perform the following steps to configure a connection with Naemon, verify the connection, and view the collected data in various BMC Helix applications.

Supported versions

BMC Helix Intelligent Integrations supports the following versions for data collection:

• Thruk version 3.14.2
• Naemon core version 1.4.2
• REST API version 1

Task 1: To plan for the connection

• Depending on the location of the third-party product (SaaS, on-premises), choose one or more BMC Helix Intelligent Integrations deployment modes and review the corresponding port requirements. For information about various deployment modes and port requirements, see Deployment-scenarios.
• Based on the deployment modes, use the BMC Helix Intelligent Integrations SaaS deployment or the BMC Helix Intelligent Integrations on-premises gateway or both. For more information about the gateway, see Deploying-the-BMC-Helix-Intelligent-Integrations-on-premises-gateway.

• The on-premises gateway must be able to reach the third-party product on the required port (default is 443).

In the preceding list, third-party product refers to Naemon.

Task 2: To configure the connection with Naemon

1. Access BMC Helix Intelligent Integrations:
   • BMC Helix Intelligent Integrations SaaS – Log on to BMC Helix Portal, and click Launch on BMC Helix Intelligent Integrations.
   • BMC Helix Intelligent Integrationson-premises gateway – Use the following URL to access BMC Helix Intelligent Integrations:
     https://<hostName>:<portNumber>/swpui
2. On the CONNECTORS tab, clickin the SOURCES panel.
3. Click the Naemon tile.
4. Specify the following details for the source connection:

   1. Specify a unique instance name.
      

      Best practice
      We recommend that you specify the instance name in the following format:

      <sourceType>_<sourceControllerServerName>{_<InstanceQualifier>}

      The instance qualifier helps you distinguish multiple instances configured from the same source server. For example, you can name your instances Naemon_Host_PROD, Naemon_Host_TEST, and so on.

      
      

   2. Specify the Naemonhost name.
   3. Specify the Naemon port number depending on the connection protocol (default value is 443).
   4. Select the Allow Unsigned Certificates option to allow HTTPS to use the self-signed certificate; select this option only for the test environment.
   5. Select the HTTPS option to use an https connection to the Naemonhost.

1. 
   
   1. Specify the number of maximum concurrent REST API requests that should be executed during a collection schedule (default value is 20).

   2. Specify the Thruk API key.
      You can create API key either from the User Profile page or by using REST API.
      For more information, see the Thruk documentataion.

   3. (Optional) Select Use Additional Authentication if you have client ID and client secret key available for authentication.
   4. Enter the client ID and client secret key.
   5. Click Proxy and specify whether you want to configure a proxy server.
      If yes, specify the host name and port number (default value is 8888).
2. Click VALIDATE AND CREATE.
   The specified connection details are validated and the corresponding source connection is created in the Source Connection list.

1. Select the source connection that you created from the list if it is not selected already.
   

   Important

   The destination host connection is created and configured automatically when the source connection is created.

2. Configure the collector for the selected data type by clicking the data type in the Collectors section and specifying the parameters for the selected data type, as explained in the following table:

   The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
   This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
   

3. Click CREATE COLLECTORS to create the required collector streams for selected data types.

4. Configure the distributors for the selected data type by clicking the data type in the Distributors section and specifying the parameters for the selected data type, as explained in the following table:

   Parameter name	Description
   Max Batching Size	Specify the maximum number of data items to send in a single POST request to the destination API. The batch size depends on the destination’s ability to buffer the incoming data. Default: 250
   Max Batching Delay	Specify the maximum time (in seconds) to wait before building a batch and processing. Default: 3 seconds
   Base Retry Delay	Specify the initial time (in seconds) for which to wait before retrying to build a batch and processing. The waiting time increases in the following sequence: n1, n2, n3, and so on, where n indicates the number of seconds. Default: 2 seconds Example: Base Retry Delay is set to 2 seconds. Retry is performed after 2, 4, 8, 16, ... seconds.
   Max Intra-Retry Delay	Specify the maximum limit for the base retry delay.  Default: 60 seconds Example: Max Intra-Retry Delay is set to 60 seconds. Base Retry Delay is set to 2 seconds. Retries are performed 2, 4, 8, 16, 32,... seconds later.
   Max Retry Duration	Specify the total time for retrying a delivery. For REST destinations, a delivery is a batch of data items in one POST request.  Default: 5 minutes Example: Max Retry Duration is set to 8 hours. Base Retry Delay is set to 2 seconds. Requests are sent for 2+4+8+16+32+64+132... until 8 hours in total duration is reached. After that, no subsequent attempts are made to retry the delivery. The assumption here is that if there is an outage or other issue with the destination tool, recovery should take less than the value of the Max Retry Duration parameter to be completed.
   JSLT mapping	Add the following code: [      {           let hostName = .extras.host_name           let entityName = .name           let entityTypeId = .measurementGroup[0]          "labels" : {               "metricName" : $entityName,                "hostname" : $hostName,               "entityId" : join(["Naemon", ":", $hostName, ":","NAEMON_"+ $entityTypeId, ":", $entityName], ""),               "entityTypeId" : "NAEMON_"+$entityTypeId,                "device_id" : .hostname,              "instanceName" : $entityTypeId,                "entityName" : $entityTypeId,               "hostType" : "Server",               "isKpi" : true,               "unit" : .unit,               "source" : "Naemon",               "external_id" : join(["NAEMON_", $hostName], "")           },           "samples" : [              { "value" : number(.value),                   "timestamp" : number(.originTimestamp)               }           ]       }   ]

   
   

5. Click CREATE DISTRIBUTORS to create the required distributor streams for the selected data types.
6. Click one of the following buttons:
   
   • SAVE STREAM: Click this button to edit the integration details before creating the instance. After you save the stream, the connector that you just created is listed in the SOURCES panel. Move the slider to the right to start the data stream.
   • SAVE AND START STREAM: Click this button to save the integration details and start receiving data immediately.

Task 3: To verify the connection

In BMC Helix Intelligent Integrations, on the SOURCES panel, confirm that the metrics data stream for the connection that you created is running.

A moving red arrow () indicates that the metric stream is running. Metric data will be pushed according to the configured Collection Schedule interval.

To view metrics in BMC Helix Operations Management

1. In BMC Helix Operations Management, select Monitoring > Devices.
2. Click the links for the required device.
3. On the Monitors tab, click the required monitor.
   The Performance Overview tab shows the metrics graph. 
   
   

For information about metrics, see Viewing collected data