Skip to main content

Allow argus-server to create tickets in Request Tracker

Project description

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 black as a source code formatter. Black can be installed by running

$ pip install black

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

$ pre-commit install

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

argus_ticket_rt-1.1.1-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file argus_ticket_rt-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for argus_ticket_rt-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 595903b53c6ebfc932ce87d8a598fa0250666fa19a881960718525c145df437c
MD5 62c9c943f40733a9620f65b00d9e4a70
BLAKE2b-256 934833c56d008abb85e4c5af2eae41ffab993a460652f4d648e7671eb91b920b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page