argus_ticket_rt

This is a plugin to create tickets in Request Tracker from Argus

The API supported is RT V2. RT 4.4 needs RT::Extension::REST2 to support V2, while RT 5.0.0 and later has the support included.

Settings

• TICKET_PLUGIN must be set to "argus_ticket_rt.RequestTrackerPlugin"

• TICKET_ENDPOINT: Link to instance, absolute URL

• TICKET_AUTHENTICATION_SECRET: Standard username/password or token:

  {
      "username": username,
      "password": password
  }
  

  or

  {
      "token": token
  }
  

  It is recommended to create an RT API user and to ensure that that user has the necessary authorization for creating tickets in the relevant queue.

  Username and password login can be disabled if the login happens through an external provider. In that case an authentication token should be used.

  If authentication tokens are enabled in RT they can be created under "Logged in as ..." -> "Settings" -> "Auth tokens".

  This could however be turned off side-wide or just for that specific user. In that case please contact the responsible RT administrator.

• TICKET_INFORMATION:

  Queue (obligatory)

  {
      "queue": queue_name
  }
  

  Custom fields (optional)

  There are two ways of automatically filling custom fields:

  1. Custom fields that are always the same, independent of the incident. These will be set in custom_fields_set with the name of the custom field as key and the fixed value as value.

     {
         "custom_fields_set" : {
             "name_of_custom_field": set_value,
         }
     }
     

  2. Custom fields that are filled by attributes of the Argus incident. These are set in custom_fields_mapping with the name of the custom field as key and the name of the attribute as it is returned by the API as value (e.g. start_time). If the information can be found in the tags the value consists of a dictionary with tag as the key and the name of the tag as the value (e.g. {"tag": "host"}).

     {
         "custom_fields_mapping" : {
             "name_of_custom_field": attribute_of_incident,
             "name_of_custom_field": {"tag": name_of_tag},
         }
     }
     

Library

The library used is rt instead of rt-client because "rt-client" does not support token authentication.

Code style

argus_ticket_rt uses ruff as a Python source code formatter and linter. Ruff can be installed by running

$ pip install ruff

A pre-commit hook will format new code automatically before committing. To enable this pre-commit hook, run

$ pre-commit install

Running tests

If you have installed tox, the following command will test argus_ticket_rt code against several Django versions, several Python versions, and automatically compute code coverage.

$ tox

An HTML coverage report will be generated. Refer to the tox.ini file for further options.