› › ›

Действие Watcher для Jira

Используйте действие jira, чтобы создавать задачи в Jira Software от Atlassian. Для создания задач необходимо настроить как минимум одну учетную запись Jira в elasticsearch.yml.

Настройка действий Jira

Действия Jira настраиваются в массиве actions. Атрибуты, специфичные для действия, указываются с помощью ключевого слова jira.

Следующий фрагмент демонстрирует простое определение действия jira:

"actions" : {
  "create-jira-issue" : {
    "transform" : { ... },
    "throttle_period" : "5m",
    "jira" : {
      "account" : "integration-account", 
      "fields" : {
          "project" : {
            "key": "PROJ" 
          },
          "issuetype" : {
            "name": "Bug" 
          },
          "summary" : "Encountered {{ctx.payload.hits.total}} errors in the last 5 minutes", 
          "description" : "Encountered {{ctx.payload.hits.total}} errors in the last 5 minutes (facepalm)", 
          "labels" : ["auto"], 
          "priority" : {
            "name" : "High" 
          }
      }
    }
  }
}

	Имя учетной записи Jira, настроенной в `elasticsearch.yml`.
	Ключ проекта Jira, в котором будет создана задача.
	Имя типа задачи.
	Краткое описание задачи Jira.
	Описание задачи Jira.
	Теги, которые необходимо применить к задаче Jira.
	Приоритет задачи Jira.

Атрибуты действия Jira

В зависимости от конфигурации проектов Jira, задачи могут иметь множество различных полей и значений. Поэтому действие jira может принимать любые типы дочерних полей в поле issue. Эти поля будут напрямую использоваться при вызове API Jira Create Issue, позволяя использовать любые типы пользовательских полей.

Поля project.key (или project.id), issuetype.name (или issuetype.id) и issue.summary всегда требуются для создания задачи в Jira.

Имя	Обязательно	Описание
`account`	нет	Учетная запись Jira для отправки сообщения.
`proxy.host`	нет	Хост прокси (только в сочетании с `proxy.port`)
`proxy.port`	нет	Порт прокси (только в сочетании с `proxy.host`)
`fields.project.key`	да	Ключ проекта Jira, в котором будет создана задача. Его можно заменить на `issue.project.id`, если идентификатор проекта известен.
`fields.issuetype.name`	да	Имя, идентифицирующее тип задачи. Jira предоставляет типы задач по умолчанию, такие как `Bug`, `Task`, `Story`, `New Feature` и т.д. Его можно заменить на `issue.issuetype.id`, если идентификатор типа известен.
`fields.summary`	да	Краткое описание (или заголовок) задачи.
`fields.description`	нет	Описание задачи.
`fields.labels`	нет	Теги для применения к задаче Jira.
`fields.priority.name`	нет	Приоритет задачи Jira. Jira предоставляет уровни приоритета по умолчанию, такие как `High`, `Medium` и `Low`.
`fields.assignee.name`	нет	Имя пользователя, которому нужно назначить задачу.
`fields.reporter.name`	нет	Имя пользователя, указанного в качестве автора задачи. По умолчанию используется учетная запись пользователя.
`fields.environment`	нет	Имя среды, связанной с задачей.
`fields.customfield_XXX`	нет	Пользовательское поле XXX задачи (например: "customfield_10000": "09/Jun/81")

Настройка учетных записей Jira

Учетные записи, которые Watcher может использовать для связи с Jira, настраиваются в пространстве имен xpack.notification.jira в elasticsearch.yml.

Watcher поддерживает базовый аутентификацию для Jira Software. Для настройки учетной записи Jira необходимо указать (см. безопасные настройки):

bin/elasticsearch-keystore add xpack.notification.jira.account.monitoring.secure_url
bin/elasticsearch-keystore add xpack.notification.jira.account.monitoring.secure_user
bin/elasticsearch-keystore add xpack.notification.jira.account.monitoring.secure_password

Хранение конфиденциальных данных (url, user и password) в файле конфигурации или настройках кластера небезопасно и устарело. Используйте безопасный метод хранения ключей Elasticsearch с помощью хранилища ключей вместо этого.

Для предотвращения передачи учетных данных в открытом виде по сети, Watcher отклонит настройки url, такие как http://internal-jira.elastic.co, которые основаны на простом протоколе HTTP. Это поведение по умолчанию можно отключить с помощью явного параметра allow_http:

Поле url также может содержать путь, используемый для создания задачи. По умолчанию это /rest/api/2/issue. Если вы также устанавливаете этот путь, убедитесь, что это полный путь к точке входа для создания задачи.

xpack.notification.jira:
  account:
    monitoring:
      allow_http: true

Сильно рекомендуется использовать базовый аутентификацию только с защищенным протоколом HTTPS.

Вы также можете указать значения по умолчанию для задач Jira:

xpack.notification.jira:
  account:
    monitoring:
      issue_defaults:
        project:
          key: proj
        issuetype:
          name: Bug
        summary: "X-Pack Issue"
        labels: ["auto"]

Если вы настроили несколько учетных записей Jira, вам либо нужно настроить учетную запись по умолчанию, либо указать, с какой учетной записью должно быть отправлено уведомление, в действии jira.

xpack.notification.jira:
  default_account: team1
  account:
    team1:
      ...
    team2:
      ...

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/actions-jira.html