Configuring Jenkins Observer jobs

Using the Jenkins Observer, you can define listen jobs that receive build information generated by the Agile Service Manager plugin for Jenkins.

Before you begin

Ensure you have all required Jenkins details to hand.

The Agile Service Manager Version 1.1.8 release targets a typical CI/CD pipeline implementation in Jenkins that makes use of a Git-based repository as the SCM, and JFrog Artifactory as the build products repository.

Before configuring the Jenkins Observer, you must install and configure the Jenkins plugin provided with the Agile Service Manager installation images (*.hpi). The plugin sends your instrumented build data to the Jenkins Observer in order to generate the appropriate topology information.

About this task

You define and start the following job.
Listen job
The standalone listen job receives Jenkins build notification data for a specified namespace and processes it as a topology.
The listen job is long-running, and runs until it is explicitly stopped or until the observer is stopped.

Procedure

  1. On the Observer jobs page, perform one of the following actions:
    To edit an existing job
    Open the List of options overflow menu next to the job and click View & edit.
    To create a new job
    Click Add a new job + and select the JNK Observer tile.
  2. Enter or edit the following parameters, then click Save to save your job and begin retrieving information.
    Table 1. Jenkins Observer job parameters
    Parameter Action Details
    Unique ID Enter a unique name for the job. Required
    Jenkins observation namespace Specify a provider namespace with which to associate all the topology data generated by this job. Required
    Access scope

    Enter text to provide a scope for the resources.

    Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens.

    		 Optional.
    Tip: You can define access scope for locations, project names, namespaces, etc.
    Generate debug support file
    Set the optional Generate debug support file parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated Support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. The file is saved to the following locations:
    On-prem
    $ASM_HOME/logs/<obs>-observer/
    On OCP
    /var/log/itsm/<obs>-observer
    		 Optional
    Observer job description Enter additional information to describe the job. Optional
    Job schedule

    Specify when the job should run, and whether it should run at regular intervals.

    By default the job runs immediately, and only once.

    Optionally you can specify a future date and time for the job to run, and then set it to run at regular intervals after that.

    Optional. Transient (one-off) jobs only.

    If you set a job schedule, the run intervals must be at least 90 seconds apart, and if you set them at less than 15 minutes, a warning is displayed, as the frequency can impact system performance.