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

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

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

Чтобы создать новый соединитель GitHub:

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

Вы можете использовать Elasticsearch API создания соединителя для создания нового собственного соединителя GitHub.

Например:

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-github-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from GitHub",
  "service_type": "github",
  "is_native": true
}

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

Чтобы использовать этот соединитель как управляемый соединитель, см. Управляемые соединители Elastic.

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

Настройте личный токен доступа GitHub для получения данных из GitHub.

Выполните следующие шаги для генерации личного токена доступа GitHub:

Настройте приложение GitHub для извлечения данных из GitHub.

Выполните эти шаги для создания приложения GitHub:

Поддерживаются как GitHub, так и GitHub Enterprise.

Необходимы следующие поля конфигурации:

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

Обрабатываются только следующие расширения файлов:

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

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

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

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

В следующих разделах приведены примеры расширенных правил синхронизации для этого коннектора.

Индексирование документов и файлов на основе имени ветки, настроенного через ключ ветки

[
  {
    "repository": "repo_name",
    "filter": {
      "branch": "sync-rules-feature"
    }
  }
]

Индексирование документов на основе запроса к вопросам, относящимся к ошибкам, через ключ вопроса

[
  {
    "repository": "repo_name",
    "filter": {
      "issue": "is:bug"
    }
  }
]

Индексирование документов на основе запроса к запросам по открытым PR через ключ PR

[
  {
    "repository": "repo_name",
    "filter": {
      "pr": "is:open"
    }
  }
]

Индексирование документов и файлов на основе запросов и имени ветки

[
  {
    "repository": "repo_name",
    "filter": {
      "issue": "is:bug",
      "pr": "is:open",
      "branch": "sync-rules-feature"
    }
  }
]

Расширенные правила для перекрытия

[
  {
    "filter": {
      "pr": "is:pr is:merged label:auto-backport merged:>=2023-07-20"
    },
    "repository": "repo_name"
  },
  {
    "filter": {
      "pr": "is:pr is:merged label:auto-backport merged:>=2023-07-15"
    },
    "repository": "repo_name"
  }
]

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

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

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

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

Этот коннектор доступен в качестве самоуправляемого самоуправляемого коннектора.

Этот самоуправляемый коннектор совместим с версиями Elastic 8.10.0+.

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

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

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

Например:

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-github-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from GitHub",
  "service_type": "github"
}

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

Для использования этого коннектора как самоуправляемого коннектора, см. Самоуправляемые коннекторы. Для дополнительных операций с использованием см. Коннекторы UI в Kibana.

Настройте персональный токен доступа GitHub для получения данных из GitHub.

Выполните следующие шаги для генерации токена доступа GitHub:

Настройте приложение GitHub для получения данных из GitHub.

Выполните следующие шаги для создания приложения GitHub:

Поддерживаются как GitHub, так и GitHub Enterprise.

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

Вы можете развернуть коннектор GitHub как самоуправляемый коннектор с помощью 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: github
    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, специфичного для источника.

В следующих разделах приведены примеры расширенных правил синхронизации для этого подключения.

Индексирование документа и файлов на основе имени ветки, настроенного через ключ ветки

[
  {
    "repository": "repo_name",
    "filter": {
      "branch": "sync-rules-feature"
    }
  }
]

Индексирование документа на основе запроса к задачам, относящимся к ошибкам, через ключ задачи

[
  {
    "repository": "repo_name",
    "filter": {
      "issue": "is:bug"
    }
  }
]

Индексирование документа на основе запроса к PR, относящимся к открытым PR, через ключ PR

[
  {
    "repository": "repo_name",
    "filter": {
      "pr": "is:open"
    }
  }
]

Индексирование документа и файлов на основе запросов и имени ветки

[
  {
    "repository": "repo_name",
    "filter": {
      "issue": "is:bug",
      "pr": "is:open",
      "branch": "sync-rules-feature"
    }
  }
]

Расширенные правила для пересечений

[
  {
    "filter": {
      "pr": "is:pr is:merged label:auto-backport merged:>=2023-07-20"
    },
    "repository": "repo_name"
  },
  {
    "filter": {
      "pr": "is:pr is:merged label:auto-backport merged:>=2023-07-15"
    },
    "repository": "repo_name"
  }
]

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

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

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

$ make ftest NAME=github

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

make ftest NAME=github DATA_SIZE=small

В настоящее время для этого подключения нет известных проблем. Список известных проблем для всех подключений см. в Известных проблемах.

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

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