Elastic GitHub connector reference
editElastic GitHub connector reference
editThe Elastic GitHub connector is a connector for GitHub. This connector is written in Python using the Elastic connector framework.
View the source code for this connector (branch 8.11, compatible with Elastic 8.11).
Native connector (Elastic Cloud)
editView native connector reference
Availability and prerequisites
editThis connector is available as a native connector as of Elastic version 8.11.0.
To use this connector natively in Elastic Cloud, satisfy all native connector requirements.
Usage
editTo use this connector as a native connector, see Native connectors.
For additional operations, see Using connectors.
GitHub access token
editConfigure 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
editBoth GitHub and GitHub Enterprise are supported.
Configuration
editThe following configuration fields are required:
- GitHub data source
- Toggle between GitHub Cloud or GitHub Server.
- Github URL
- URL of the GitHub Server instance. (GitHub Server only)
- GitHub Token
- GitHub access token to authenticate the GitHub instance.
- List of 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.
- Enable SSL
- Enable SSL for the GitHub instance.
- SSL certificate
-
SSL certificate for the GitHub instance. Example:
-----BEGIN CERTIFICATE----- MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT ... 7RhLQyWn2u00L7/9Omw= -----END CERTIFICATE-----
Documents and syncs
editThe 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
editBasic sync rules are identical for all connectors and are available by default. For more information read Types of sync rule.
Advanced sync rules
editA 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
editSee Content extraction.
Known issues
editThere are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Connector client (self-managed)
editView connector client reference
Availability and prerequisites
editThis connector is available as a self-managed connector client.
This connector client is compatible with Elastic versions 8.10.0+.
To use this connector, satisfy all connector client requirements.
Usage
editSelf-manage this connector
Because this client is available as a native connector, you’ll first need to convert to a connector client in the Kibana UI. This action is irreversible. Use the Convert connector button on the right-hand side of the configuration page.
To use this connector as a connector client, see Connector clients.
For additional usage operations, see Using connectors.
GitHub access token
editConfigure 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
editBoth GitHub and GitHub Enterprise are supported.
Configuration
editWhen 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:
-
data source
- GitHub Cloud or GitHub Server.
-
host
- URL of the GitHub Server instance. (GitHub Server only)
-
github_token
- GitHub access token to authenticate the GitHub instance.
-
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
-
the
kibana
repo synced will be the Elastic owned repo
This field can be bypassed by advanced sync rules.
-
ssl_enabled
-
Whether SSL verification will be enabled. Default value is
False
. -
ssl_ca
-
Content of SSL certificate. Note: If
ssl_enabled
isFalse
, the value in this field is ignored. Example certificate:-----BEGIN CERTIFICATE----- MIID+jCCAuKgAwIBAgIGAJJMzlxLMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNVBAYT ... 7RhLQyWn2u00L7/9Omw= -----END CERTIFICATE-----
-
retry_count
-
The number of retry attempts after failed request to GitHub. Default value is
3
. -
use_text_extraction_service
-
Requires a separate deployment of the Elastic Text Extraction Service. Requires that pipeline settings disable text extraction.
Default value is
False
.
Deployment using Docker
editYou 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.11.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
editThe 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
editBasic sync rules are identical for all connectors and are available by default. For more information read Types of sync rule.
Advanced sync rules
editA 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
editSee Content extraction.
Connector client operations
editEnd-to-end testing
editThe 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
editThere are currently no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.