Справочник по коннектору Elastic Jira

Этот соединитель доступен как управляемый соединитель в Elastic Cloud, начиная с версии 8.9.1.

Для использования этого соединителя напрямую в Elastic Cloud выполните все требования к управляемым соединителям.

Для создания нового соединителя Jira:

Для дополнительных операций см. Пользовательский интерфейс соединителей в Kibana.

Вы можете использовать Elasticsearch API для создания соединителя, чтобы создать новый родной соединитель Jira.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
    is_native=True,
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
  is_native: true,
});
console.log(response);

PUT _connector/my-jira-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Jira",
  "service_type": "jira",
  "is_native": true
}

Подробную информацию обо всех доступных API соединителей см. в документации Elasticsearch API.

Для использования этого соединителя напрямую в Elastic Cloud см. Управляемые соединители Elastic.

Для дополнительных операций см. Пользовательский интерфейс соединителей в Kibana.

Для настройки соединителя требуются следующие поля конфигурации:

Соединитель синхронизирует следующие объекты и сущности:

Примечание: Архивированные проекты и задачи не индексируются.

Полные синхронизации поддерживаются по умолчанию для всех соединителей.

Этот соединитель также поддерживает инкрементные синхронизации.

Основные правила синхронизации одинаковы для всех соединителей и доступны по умолчанию.

Этот соединитель поддерживает расширенные правила синхронизации для удалённого фильтра. Эти правила охватывают сложные сценарии запросов и фильтрации, которые нельзя выразить с помощью основных правил синхронизации. Расширенные правила синхронизации определяются с помощью JSON-фрагмента DSL, специфичного для источника.

Пример 1: Запросы для индексирования содержимого на основе статуса задач Jira.

[
  {
    "query": "project = Collaboration AND status = 'In Progress'"
  },
  {
    "query": "status IN ('To Do', 'In Progress', 'Closed')"
  }
]

Пример 2: Запрос для индексирования данных на основе приоритета задач для заданных проектов.

[
  {
    "query": "priority in (Blocker, Critical) AND project in (ProjA, ProjB, ProjC)"
  }
]

Пример 3: Запрос для индексирования данных на основе исполнителя и времени создания.

[
  {
    "query": "assignee is EMPTY and created < -1d"
  }
]

Безопасность на уровне документа (DLS) позволяет ограничить доступ к документам на основе разрешений пользователя. Обратитесь к настройкам на этой странице, чтобы узнать, как включить DLS для этого соединителя.

См. Извлечение содержимого.

Обратитесь к Известным проблемам для получения списка известных проблем для всех соединителей.

См. Отладку.

См. Безопасность.

Этот коннектор доступен в качестве управляемого пользователем коннектора. Этот управляемый пользователем коннектор совместим с версиями Elastic 8.7.0+.

Для использования этого коннектора, выполните все требования к управляемому пользователем коннектору.

Для создания нового коннектора Jira:

Вы можете использовать API Elasticsearch создания коннектора для создания нового управляемого пользователем коннектора Jira.

Например:

resp = client.connector.put(
    connector_id="my-{service-name-stub}-connector",
    index_name="my-elasticsearch-index",
    name="Content synced from {service-name}",
    service_type="{service-name-stub}",
)
print(resp)

const response = await client.connector.put({
  connector_id: "my-{service-name-stub}-connector",
  index_name: "my-elasticsearch-index",
  name: "Content synced from {service-name}",
  service_type: "{service-name-stub}",
});
console.log(response);

PUT _connector/my-jira-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Jira",
  "service_type": "jira"
}

Для получения подробной информации обо всех доступных API коннекторов обратитесь к документации API Elasticsearch.

Чтобы использовать этот коннектор как управляемый пользователем коннектор, см. Управляемые пользователем коннекторы. Для дополнительных операций по использованию см. Интерфейс коннекторов в Kibana.

Для настройки коннектора требуются следующие поля конфигурации:

Вы можете развернуть коннектор Jira в качестве управляемого пользователем коннектора с помощью Docker. Следуйте этим инструкциям.

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: jira
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.17.3 \
/app/bin/elastic-ingest \
-c /config/config.yml

Для получения более подробной информации обратитесь к DOCKER.md в репозитории elastic/connectors.

Найдите все доступные образы Docker в официальном реестре.

Коннектор синхронизирует следующие объекты и сущности:

Примечание: Архивированные проекты и задачи не индексируются.

Полные синхронизации поддерживаются по умолчанию для всех коннекторов.

Этот коннектор также поддерживает инкрементные синхронизации.

Основные правила синхронизации одинаковы для всех коннекторов и доступны по умолчанию.

Этот коннектор поддерживает расширенные правила синхронизации для удалённого фильтра. Эти правила охватывают сложные сценарии запросов и фильтрации, которые нельзя выразить с помощью основных правил синхронизации. Расширенные правила синхронизации определяются с помощью специфичного для источника фрагмента JSON DSL.

Пример 1: Запросы для индексации содержимого на основе статуса задач Jira.

[
  {
    "query": "project = Collaboration AND status = 'In Progress'"
  },
  {
    "query": "status IN ('To Do', 'In Progress', 'Closed')"
  }
]

Пример 2: Запрос для индексации данных на основе приоритета задач для заданных проектов.

[
  {
    "query": "priority in (Blocker, Critical) AND project in (ProjA, ProjB, ProjC)"
  }
]

Пример 3: Запрос для индексации данных на основе назначенного исполнителя и времени создания.

[
  {
    "query": "assignee is EMPTY and created < -1d"
  }
]

Безопасность на уровне документов (DLS) позволяет ограничить доступ к документам на основе разрешений пользователя. Обратитесь к настройкам на этой странице, чтобы узнать, как включить DLS для этого коннектора.

См. Извлечение содержимого.

Фреймворк коннекторов позволяет операторам запускать функциональные тесты с реальным источником данных. Обратитесь к Тестирование коннекторов для получения более подробной информации.

Для выполнения конечного тестирования коннектора Jira выполните следующую команду:

$ make ftest NAME=jira

Для более быстрых тестов добавьте флаг DATA_SIZE=small:

make ftest NAME=jira DATA_SIZE=small

Обратитесь к Известные проблемы для списка известных проблем всех коннекторов.

См. Устранение неполадок.

См. Безопасность.