Defining Application Discovery Observer jobs

You use the Application Discovery Observer to retrieve network topology data from the Application Discovery database via REST API, and then use this data to create topologies within the topology service.

Before you begin

The Application Discovery services are installed as part of the core installation procedure. This includes the Application Discovery Observer, Application Discovery engines and Db2 docker containers, which have been installed and should be running, as well as the required scripts to manage jobs.

Verify the Application Discovery deployment before configuring the observer jobs.
  1. Use the following command to verify that the docker containers are running:
    ASM_HOME/bin/docker-compose ps
    The system should return output indicating that the following containers have a state of Up and therefore are running:
    ...
    asm_appdisco-observer_1
    asm_app-disco-discovery_1
    asm_app-disco-primarystorage_1
    asm_db2_1
  2. Check that storage and discovery services are running and have started:
    $ docker exec -ti asm_app-disco-primarystorage_1 /opt/IBM/taddm/dist/bin/control status
Tip: You can also check the following logs:
ASM_HOME/logs/db2/create_database.log
ASM_HOME/logs/app-disco-pss/pss/wlp.log
Remember: Swagger documentation for the observer is available at the following default location: https://<your host>/1.0/appdisco-observer/swagger

About this task

To use the Application Discovery component, you must complete two steps:
Configure the discovery information
Configure Application Discovery details. When successful, the configuration details will be saved in topology management artifacts.
This procedure is described here: Configuring application discovery service
Configure the full load job
Triggers Application Discovery, and discovers data.
This task is described in the following procedure.
By default, these jobs are one-off, transient jobs that carry out a full upload of all requested topology data when they are triggered.
You can also run these jobs (again) manually from the Observer UI, or schedule them to run at set times when you configure them.

The Application Discovery Observer retrieves application data from the database of Application Discovery via REST APIs. Once the discovery configuration has been successfully sent to the topology management artifact and Application Discovery, you can run a full load job to discover Application Discovery data.

Note: You can only run one job per profile.

Procedure

  1. Edit the configuration file as required.
    See the following topic for more details: Configuring application discovery service
  2. Open the appdisco_observer_common.sh configuration file and edit (at least) the following parameters:
    unique_id
    The unique ID of the job
    config_id
    Set the Application Discovery configuration ID.
    The value must be the same value as defined for the configId property in the commmonconfig.json file.
    active_discovery
    Set to 'true' to trigger Application Discovery and Application Discovery Observer discovery.
    Set to 'false' to trigger Application Discovery Observer discovery only.
    filter_date
    Optional.
    The date indicates the range of past resources to be discovered.
    Leave empty for snapshot discovery.
    The date must be in dd-mm-yyyy HH:mm:ss format.
  3. To start the Application Discovery Observer Load job, use one of the following commands:
    • This command triggers the job to load all requested topology data.
      $ASM_HOME/bin/appdisco_observer_load_start.sh
    • Alternatively, you can start the load job using the following cURL command:
      curl –insecure -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'X-TenantID: cfd95b7e-3bc7-4006-a4a8-a73a79c71255' --header 'Authorization: Basic YXNtOmFzbQ==' -d '{
        "unique_id": "my job",
        "type": "string",
        "description": "job description",
        "parameters": {
          "config_id": "default-appdisco",
          "active_discovery": true,
          "filter_date": "dd-mm-yyyy HH:mm:ss"
        },
      }' 'https://localhost/1.0/Application Discovery-observer/jobs/load'

Results

The Application Discovery Observer job discovers and then uploads the application services data to the Agile Service Manager topology service.

What to do next

You can also use the following scripts:
appdisco_observer_load_stop.sh
Stops the load job
appdisco_observer_job_list.sh
Lists the status of current jobs
appdisco_observer_log_level.sh
Sets the log level
Remember: As an alternative to being configured using the Observer Configuration UI, observer jobs have scripts to start and stop all available jobs, to list the status of a current job, and to set its logging levels. These scripts can be run with -h or --help to display help information, and with -v or --verbose to print out the details of the actions performed by the script, including the full cURL command. For the on-prem version of Agile Service Manager, observer scripts are configured for specific jobs by editing the script configuration files.