IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elastic Dropbox connector reference Elastic Gmail connector reference »
Elastic Docs › ›Elastic connectors

Elastic GitHub connector reference

edit

Elastic GitHub connector reference

edit

The Elastic GitHub connector is a connector for GitHub.

Availability and prerequisites

edit

This connector is available as a native connector as of Elastic version 8.11.0.

This connector is available as a connector client from the Elastic connector framework.

This connector client is compatible with Elastic versions 8.10.0+.

To use this connector, satisfy all connector client requirements.

This connector is in beta and is subject to change. Technical preview features are subject to change and are not covered by the support SLA of generally available (GA) features. Elastic plans to promote this feature to GA in a future release.

Usage

edit

To use this connector as a connector client, use the GitHub tile from the connectors list or Customized connector workflow. For additional operations, see Using connectors.

GitHub access token

edit

Configure a GitHub access token to fetch data from GitHub.

Follow these steps to generate a GitHub access token:

  • Go to GitHub Settings → Developer settings → Personal access tokens → Tokens(classic).
  • Select Generate new token.
  • Add a note and select the "repo" scope.
  • Select Generate token and copy the token.

Compatibility

edit

Both GitHub and GitHub Enterprise are supported.

Configuration

edit

When using the build a connector workflow, initially these fields will use the default configuration set in the connector source code. These are set in the get_default_configuration function definition.

These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.

The following configuration fields are required:

github_token
GitHub access token to authenticate the GitHub instance.
data_source`
Toggle between GitHub Cloud or GitHub Server.
host
URL of the GitHub Server instance. (GitHub Server only)
repositories

Comma-separated list of repositories to fetch data from GitHub instance. If the value is * the connector will fetch data from all repositories present in the configured user’s account.

Default value is *.

Examples:

  • elasticsearch,elastic/kibana
  • *

Repository ownership

If the "OWNER/" portion of the "OWNER/REPO" repository argument is omitted, it defaults to the name of the authenticating user.

In the examples provided here:

  • the elasticsearch repo synced will be the <OWNER>/elasticsearch repo
  • the kibana repo synced will be the Elastic owned repo

This field can be bypassed by advanced sync rules.

retry_count
The number of retry attempts after failed request to GitHub. Default value is 3.

Deployment using Docker

edit

You can deploy the GitHub connector as a self-managed connector client using Docker. Follow these instructions.

Step 1: Download sample configuration file

Download the sample configuration file. You can either download it manually or run the following command:

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

Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.

Step 2: Update the configuration file for your self-managed connector

Update the configuration file with the following settings to match your environment:

  • elasticsearch.host
  • elasticsearch.api_key
  • connectors

If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:

# 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>

Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and elasticsearch.password to authenticate with your Elasticsearch instance.

Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.

Step 3: Run the Docker image

Run the Docker image with the Connector Service using the following command:

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

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

Documents and syncs

edit

The connector syncs the following objects and entities:

  • Repositories
  • Pull Requests
  • Issues
  • Files & Folder

Only the following file extensions are ingested:

  • .markdown
  • .md
  • .rst
  • Content of files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elasticsearch Index.

Sync rules

edit

Basic sync rules are identical for all connectors and are available by default. For more information read Types of sync rule.

Advanced sync rules

edit

A full sync is required for advanced sync rules to take effect.

The following section describes advanced sync rules for this connector. Advanced sync rules are defined through a source-specific DSL JSON snippet.

The following sections provide examples of advanced sync rules for this connector.

Indexing document and files based on branch name configured via branch key
edit
[
  {
    "repository": "repo_name",
    "filter": {
      "branch": "sync-rules-feature"
    }
  }
]
Indexing document based on issue query related to bugs via issue key
edit
[
  {
    "repository": "repo_name",
    "filter": {
      "issue": "is:bug"
    }
  }
]
Indexing document based on PR query related to open PR’s via PR key
edit
[
  {
    "repository": "repo_name",
    "filter": {
      "pr": "is:open"
    }
  }
]
Indexing document and files based on queries and branch name
edit
[
  {
    "repository": "repo_name",
    "filter": {
      "issue": "is:bug",
      "pr": "is:open",
      "branch": "sync-rules-feature"
    }
  }
]

All documents pulled by a given rule are indexed regardless of whether the document has already been indexed by a previous rule. This can lead to document duplication, but the indexed documents count will differ in the logs. Check the Elasticsearch index for the actual document count.

Advanced rules for overlapping
edit
[
  {
    "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"
  }
]

Content Extraction

edit

See Content extraction.

Connector client operations

edit

End-to-end testing

edit

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the GitHub connector, run the following command:

$ make ftest NAME=github

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=github DATA_SIZE=small

Known issues

edit

There are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Framework and source

edit

This connector is built with the Elastic connector framework.

View the source code for this connector (branch 8.10, compatible with Elastic 8.10).

« Elastic Dropbox connector reference Elastic Gmail connector reference »