Configure Jira Edge Connector

Configure Jira Edge Connector

Environment variables

Set the configuration file properties such as location and path. But first, you need to set some environment variables for the local configuration file. You can get the configuration file:

  • from a local drive

  • by using git

Reading configuration files from a local drive

Set the JEC_CONF_SOURCE_TYPE and JEC_CONF_LOCAL_FILEPATH variables.

Reading configuration files from a git repository

Set the JEC_CONF_GIT_URLJEC_CONF_GIT_FILEPATHJEC_CONF_GIT_PRIVATE_KEY_FILEPATH, and JEC_CONF_GIT_PASSPHRASE variables. If you are using a public repository, you should use an https format of a git URL and you don’t need to set a private key and passphrase. You can optionally set JEC_API_KEY; if this property is set in the environment, its value is used as apiKey or else apiKey from the configuration file is used.

Use the ‘~’ character as home directory for running the program as a user in a customer’s server.

Flag

You can gather Prometheus default metrics from http://localhost:<port-number>/metrics. To run multiple JEC instances in the same environment, set the -jec-metrics as distinct port number values: -jec-metrics <port-number>

Logs

Logs for JEC are located at the following:

  • Windows: var/log/jsm/jec<pid>.log

  • Linux: /var/log/jsm/jec<pid>.log

At the end of the file name, there is a program identifier (pid) that indicates which process is running.

Configuration file

JEC supports json and yaml file extensions with fields. Set the configuration file path in JEC_CONF_LOCAL_FILEPATH or JEC_CONF_GIT_FILEPATH based on whether it is local or git.

The local variable of args, flags, and env overrides the global variables.

  • apiKey, jsmUrl (baseUrl), and payload (JEC callback as JSON) pass to args as flag format. These flags should be parsed in action scripts or executables.

  • The payload consists of alert information and integration-specific parameters. Integration-specific parameters exist for “Send via JEC” option.

  • JEC updates the git repositories every 1 minute.

JEC integration uses direct actions (for example, Create, Close, Acknowledge, etc). Other integrations primarily use mapped actions related to themselves (for example, addCommentToIssue, createIssue, etc. for Jira integration).