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

Этот коннектор доступен как управляемый коннектор (управляемая служба) в Elastic Cloud.

Этот коннектор совместим с версиями Elastic 8.13.0+.

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

Чтобы создать новый коннектор Gmail:

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

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

Например:

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

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

Чтобы использовать этот коннектор как управляемый коннектор в Elastic Cloud, используйте рабочий процесс Коннекторы в пользовательском интерфейсе Kibana.

Чтобы создать новый коннектор Gmail:

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

Перед синхронизацией данных из GMail вам необходимо создать сервис-аккаунт с соответствующим доступом к API GMail и Google Directory, который является частью API Google Admin SDK. Вам также необходимо включить делегирование на уровне домена для имитации пользователей, сообщения которых вы получаете.

Для начала войдите в Google Cloud Platform и перейдите в Console.

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

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

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

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

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

Доступны расширенные правила синхронизации для этого коннектора. Коннектор поддерживает синтаксис расширенного поиска GMail в поле messages.

Например:

{
  "messages": [
    "before:2021/10/10",
    "from:amy"
  ]
}

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

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

См. Отладку.

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

Этот коннектор разработан на Python с использованием фреймворка Elastic для коннекторов.

Просмотрите исходный код этого коннектора (ветка 8.17, совместима с Elastic 8.17).

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

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

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

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

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

Например:

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

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

Для использования этого соединителя в качестве самостоятельно управляемого соединителя используйте рабочий процесс Соединителя в пользовательском интерфейсе Kibana.

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

Перед синхронизацией любых данных из GMail, вам необходимо создать сервис-аккаунт с соответствующим доступом к API GMail и Google Directory, который является частью API Google Admin SDK. Вам также нужно включить делегирование полномочий на уровне домена для имитации пользователей, из которых вы получаете сообщения.

Для начала войдите в Google Cloud Platform и перейдите к Console.

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

Вы можете развернуть соединитель Gmail как самостоятельно управляемый соединитель с использованием 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: gmail
    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-образы в официальном репозитории.

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

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

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

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

Для этого коннектора доступны расширенные правила синхронизации. Коннектор поддерживает синтаксис расширенного поиска Gmail в поле messages.

Например:

{
  "messages": [
    "before:2021/10/10",
    "from:amy"
  ]
}

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

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

См. Поиск решения проблем.

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

Этот коннектор разработан на Python с использованием фреймворка Elastic для коннекторов.

Просмотреть исходный код этого коннектора (ветка 8.17, совместима с Elastic 8.17).