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

feat: add vector with defaults #93

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

Ian2012
Copy link
Contributor

@Ian2012 Ian2012 commented Nov 6, 2024

Description

This PR adds Vector as a dependency and sets defaults for:

  • Extracting application logs (lms, cms, ingress, cert-manager, etc)
  • Extracting tracking logs from Open edX.
  • Storing compressed tracking logs in gzip files on an S3-like storage (can be tweaked to work with Cloudwatch, Minio, etc) by date.

Closes: #32

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 6, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @Ian2012!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/openedx-k8s-harmony-maintainers. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@Ian2012
Copy link
Contributor Author

Ian2012 commented Nov 6, 2024

@pomegranited @bmtcril You may be interested as well on this PR

charts/harmony-chart/values.yaml Outdated Show resolved Hide resolved
charts/harmony-chart/values.yaml Outdated Show resolved Hide resolved
type: remap
inputs:
- kubernetes_tutor_logs
source: |-
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this going to work with the existing Aspects vector settings? Are the two going to be exclusive?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, both need to be exclusive, for resource consumption and pipeline tracking. However, another filter and a sink can be added to filter specifics of any namespace.

However, keep in mind that Ralph is the recommended pipeline to use.

I can leave examples for it

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've implemented a ClickHouse filter and sink example. Assuming there are multiple OpenedX installations in the same cluster, a filter, a transformer, and a sink must be implemented per namespace.

Basically what we do is:

  • Get all logs from a specific namespace (filter)
  • Get all xapi_tracking logs. (transformer)
  • Sink them to the specific ClickHouse instance/cluster. (sink)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Ian2012 Can you please give an example for multiple instance per cluster configuration setup in the https://github.com/openedx/openedx-k8s-harmony/blob/main/values-example.yaml?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the values-example.yaml with the elements for one installation filtered by namespace. It just needs to be replicated for every openedx namespace with Aspects installed.

charts/harmony-chart/values.yaml Outdated Show resolved Hide resolved
@Ian2012
Copy link
Contributor Author

Ian2012 commented Nov 20, 2024

I've updated the default values as the sinks cannot be disabled, they need to be removed. Examples were added to setup CloudWatch and S3 sinks. This was tested on a production environment with CloudWatch, S3, and VictoriaLogs sinks, everything worked well and logs for the lms|cms are grouped when there are exceptions.

values-example.yaml Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: In Eng Review
Development

Successfully merging this pull request may close these issues.

Log collection and aggregation
5 participants