argus_ticket_gitlab

This is a plugin to create tickets in Gitlab from Argus

Settings

• TICKET_PLUGIN: "argus_ticket_gitlab.GitlabPlugin"

• TICKET_ENDPOINT: "https://gitlab.com/" or link to self-hosted instance, absolute URL

• TICKET_AUTHENTICATION_SECRET: Create a project access token or a personal access token with the scope api:

  {
      "token": token
  }
  

  It is recommended to create a Gitlab API user and to ensure that that user has the necessary authorization for creating issues in the relevant repository.

• TICKET_INFORMATION:

  Project namespace and name (obligatory)

  {
      "project_namespace_and_name": project_namespace_and_name
  }
  

  To know which project to create the ticket in the Gitlab API needs to know the owner and name of it.

  To figure out the namespace visit the namespace page of the Gitlab documentation. The name is the name of the Gitlab project.

  For the Github project Simple Maven Example the dictionary would look like this:

  {
     "project_namespace_and_name": "gitlab-examples/maven/simple-maven-example",
  }
  

  Labels (optional)

  There are two ways of automatically filling labels:

  1. Labels that are always the same, independent of the incident. These will be set in labels_set.

     {
         "labels_set" : [
             label1,
             label2,
             label3,
         ]
     }
     

  2. Labels that are filled by attributes of the Argus incident. These are set in labels_mapping which is a list of the names of the attributes as they are returned by the API (e.g. start_time). If the information can be found in the tags the it has to be a dictionary with tag as the key and the name of the tag as the value (e.g. {"tag": "host"}).

     {
         "labels_mapping" : [
             attribute_of_incident,
             {"tag": name_of_tag},
         ]
     }
     

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_jira 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.