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

Implement a logging system for all hfla github actions #1445

Closed
4 tasks
akibrhast opened this issue Apr 23, 2021 · 8 comments
Closed
4 tasks

Implement a logging system for all hfla github actions #1445

akibrhast opened this issue Apr 23, 2021 · 8 comments
Assignees
Labels
Complexity: Large enhancement New feature or request suggestion Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly Research Tasks for researchers role: back end/devOps Tasks for back-end developers size: 5pt Can be done in 19-30 hours To Update ! No update has been provided

Comments

@akibrhast
Copy link
Member

akibrhast commented Apr 23, 2021

Overview

As a member of the website team, we need a system that allows us to track GitHub action logs for an extended amount of time, beyond GitHub's 90 day allowance.

Action items

  • Create some sort of system that allows logging of Github actions logs for an extended amount of time.
    • The logs should be stored in a .txt file in a directory called '/logs' which is added to .gitignore
    • The log needs to have a one to one correspondence with the GitHub actions logs. This means that all information logged by GitHub needs to also be logged in this system. (this includes time stamps and information about the triggers)
    • The only exception to the above is the code that is run. However, the name of the GitHub actions file should be in the log.

Resources/Instructions

If you have trouble starting this project, you might start with implementing the log with a GitHub action. The workflow_run trigger seems very promising if this is the route you want to take.

As this issue is fairly large, you might have a lot of trouble, so please reach out! Important things to keep in mind when designing this is that this is made for the team. Be conscious of how the logs are formed and formatted, so that they would be useful for the team! You might also want to improve upon the action items above (perhaps a way to clear the logs?). If you dare to challenge yourself, be sure to share that intention with the team! We love to hear your ideas.

Some useful links

Keeping your GitHub Actions and workflows secure: Preventing pwn requests
Events that trigger workflows
Workflow syntax for GitHub Actions
Storing workflow data as artifacts
GitHub GraphQL

@sayalikotkar sayalikotkar added the Feature Missing This label means that the issue needs to be linked to a precise feature label. label Jun 20, 2021
@akibrhast
Copy link
Member Author

To discuss with @Aveline-art

@Aveline-art Aveline-art added Discussion Starting point for gathering further information and/or feedback enhancement New feature or request suggestion Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly Research Tasks for researchers role: back end/devOps Tasks for back-end developers Complexity: Large and removed Feature Missing This label means that the issue needs to be linked to a precise feature label. role missing labels Jun 26, 2021
@Aveline-art
Copy link
Member

Aveline-art commented Jun 26, 2021

Design/Research questions:

  • Where and how will the information be stored?
  • What ways are there to listen for the initiation or completion of a GitHub action?
  • What information has to be part of the log?
  • Who is the end user of the logging system?
  • What does the current logging system lack that this needs to address? Answer: The current logging system only preserve logs for the last 3 months. It should preserve logs for over that amount.

Design criteria:
TBD.

@akibrhast
Copy link
Member Author

Discussed with @Aveline-art and added details in the main body.

@ExperimentsInHonesty
Copy link
Member

ExperimentsInHonesty commented Jun 28, 2021

This issue needs a rewrite on the top, to be in the format of all our other issues

 ### Overview
 User story (as a ____ I need to do _____ for _____ reason)

### Action Items
- [ ] thing 1
- [ ] thing 2

### Resources/Instructions
Links that will be useful

@abuna1985 abuna1985 removed the Discussion Starting point for gathering further information and/or feedback label Jul 2, 2021
@Zak234 Zak234 self-assigned this Jul 10, 2021
@Sihemgourou Sihemgourou added the To Update ! No update has been provided label Jul 18, 2021
@github-actions
Copy link

@Zak234 Please add update

  1. Progress
  2. Blockers
  3. Availability
  4. ETA

@Zak234
Copy link
Contributor

Zak234 commented Jul 25, 2021

Still working on the Github action. Experimenting with Javascript and Graph Ql. Available basically anytime. ETA, hopefully one week.

@Zak234
Copy link
Contributor

Zak234 commented Aug 4, 2021

Talked with Ava and it was decided that this issue should be closed due to its complexity and lack of benefits from completion. In case of being opened in the future, using REST API to download job logs seemed to be the most promising avenue although large amount of data processing would need to be done to remove the Github action code from the logs and get the data in a more readable state.

@Zak234 Zak234 closed this as completed Aug 4, 2021
@ExperimentsInHonesty
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Large enhancement New feature or request suggestion Feature: Board/GitHub Maintenance Project board maintenance that we have to do repeatedly Research Tasks for researchers role: back end/devOps Tasks for back-end developers size: 5pt Can be done in 19-30 hours To Update ! No update has been provided
Projects
Development

No branches or pull requests

8 participants