Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Index GitHub Events to the Metrics cluster #76

Open
Tracked by #57
bshien opened this issue Sep 18, 2024 · 0 comments
Open
Tracked by #57

[FEATURE] Index GitHub Events to the Metrics cluster #76

bshien opened this issue Sep 18, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request untriaged Issues that have not yet been triaged

Comments

@bshien
Copy link
Collaborator

bshien commented Sep 18, 2024

Is your feature request related to a problem?

Coming from #75

In order to index data about maintainer_engagement, there first needs to be GitHub Events indexed into the Metrics cluster.

What solution would you like?

There should be an index in the Metrics cluster called github_events that has documents representing GitHub Events created in the OpenSearch project.

Using a GitHub App, listen on GitHub Events created by the opensearch-project organization. Index a document for each event with these fields:

{
  id, // Unique identifier for the event.
  type, // The type of event.
  actor.login, // The username of the actor that triggered the event.
  repo.name, // The name of the repository.
  created_at // The date and time the event was triggered.
  payload.action // The action that was performed(opened, edited, closed, etc.)
}

Document will look like:

{
    "id": "2038382333",
    "type": "IssuesEvent",
    "action": "edited",
    "actor": "bshien",
    "repository": "opensearch-metrics",
    "created_at": "2024-08-27T00:31:56Z"
}

What alternatives have you considered?

An alternative is using the GitHub Events API to query past Events, but because it is a pull-based system, it is not trivial to add only new Events that have not already been indexed into the cluster.

Do you have any additional context?

#57

@bshien bshien added enhancement New feature or request untriaged Issues that have not yet been triaged labels Sep 18, 2024
@bshien bshien self-assigned this Sep 18, 2024
@bshien bshien removed the untriaged Issues that have not yet been triaged label Sep 18, 2024
@github-actions github-actions bot added the untriaged Issues that have not yet been triaged label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request untriaged Issues that have not yet been triaged
Projects
Status: 🏗 In progress
Development

No branches or pull requests

1 participant