Справочник по подключению Elastic Dropbox

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

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

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

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

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

Например:

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

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

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

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

Перед настройкой коннектора вам необходимо:

Вам необходимо создать приложение OAuth на платформе Dropbox, выполнив следующие шаги:

Чтобы сгенерировать токен обновления, выполните следующие шаги:

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

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

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

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

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

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

Расширенные правила синхронизации для Dropbox позволяют синхронизировать файлы Dropbox на основе запроса, который соответствует строкам в имени файла. Вы можете дополнительно отфильтровать результаты запроса по file_extensions или file_categories. Если оба фильтра указаны, приоритет отдается file_categories. Ниже приведены несколько примеров для иллюстрации.

Пример: Только запрос

[
  {
    "query": "confidential"
  },
  {
    "query": "dropbox"
  }
]

Пример: Запрос с фильтром расширения файла

[
  {
    "query": "dropbox",
    "options": {
      "file_extensions": [
        "txt",
        "pdf"
      ]
    }
  }
]

Пример: Запрос с фильтром категории файла

[
  {
    "query": "test",
    "options": {
      "file_categories": [
        {
          ".tag": "paper"
        },
        {
          ".tag": "png"
        }
      ]
    }
  }
]

Ограничения

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

См. Поиск и устранение неисправностей для списка советов по устранению неполадок для всех соединителей.

См. Безопасность для списка рекомендаций по безопасности для всех соединителей.

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

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

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

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

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

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

Например:

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

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

Прежде чем вы сможете настроить свой соединитель, вам потребуется:

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

Вам нужно создать приложение OAuth на платформе Dropbox, выполнив следующие действия:

Чтобы сгенерировать токен обновления, выполните следующие действия:

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

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

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

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

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

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

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

Расширенные правила синхронизации для Dropbox позволяют синхронизировать файлы Dropbox на основе запроса, соответствующего строкам в имени файла. Вы можете дополнительно фильтровать результаты запроса по file_extensions или file_categories. При указании обоих параметров приоритет отдается file_categories. Ниже приведены несколько иллюстративных примеров.

Пример: Только запрос

[
  {
    "query": "confidential"
  },
  {
    "query": "dropbox"
  }
]

Пример: Запрос с фильтром расширения файла

[
  {
    "query": "dropbox",
    "options": {
      "file_extensions": [
        "txt",
        "pdf"
      ]
    }
  }
]

Пример: Запрос с фильтром категории файла

[
  {
    "query": "test",
    "options": {
      "file_categories": [
        {
          ".tag": "paper"
        },
        {
          ".tag": "png"
        }
      ]
    }
  }
]

Ограничения

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

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

$ make ftest NAME=dropbox

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

make ftest NAME=dropbox DATA_SIZE=small

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

См. Устранение неполадок для получения советов по устранению неполадок для всех коннекторов.

См. Безопасность для получения советов по безопасности для всех коннекторов.

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