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

out_cloudwatch_logs: add support for record accessor #3246

Open
dahu33 opened this issue Mar 18, 2021 · 20 comments
Open

out_cloudwatch_logs: add support for record accessor #3246

dahu33 opened this issue Mar 18, 2021 · 20 comments
Assignees
Labels
AWS Issues with AWS plugins or experienced by users running on AWS enhancement

Comments

@dahu33
Copy link

dahu33 commented Mar 18, 2021

Is your feature request related to a problem? Please describe.

I would like to dynamically add the Kubernetes namespace in the Cloudwatch Logs group name. This is useful to:

  • restrict user log access to certain namespaces.
  • log ingestion monitoring (Cloudwatch Logs metrics are per log group name).

Describe the solution you'd like
I believe the solution would be to implement record accessor in the out_cloudwatch_logs plugin. That way the user could freely name its log groups and log streams based on record information.

Example:

[OUTPUT]
    Name cloudwatch_logs
    Match   *
    region us-east-1
    log_group_name /aws/containerinsights/${CLUSTER_NAME}/namespace/$kubernetes['namespace_name']

Describe alternatives you've considered
Is there any?

@dahu33
Copy link
Author

dahu33 commented Mar 18, 2021

@PettitWesley @edsiper would you mind having look at this?

@PettitWesley
Copy link
Contributor

I believe the solution would be to implement record accessor in the out_cloudwatch_logs plugin. That way the user could freely name its log groups and log streams based on record information.

@dahu33 I believe you are correct

We built a templating feature in the cloudwatch go plugin: https:/aws/amazon-cloudwatch-logs-for-fluent-bit#templating-log-group-and-stream-names

It would be cool to implement it in the cloudwatch_logs plugin too, but I am not prioritizing it right now since we already have the go plugin templating implementation.

@PettitWesley PettitWesley self-assigned this Mar 31, 2021
@PettitWesley PettitWesley added the AWS Issues with AWS plugins or experienced by users running on AWS label Mar 31, 2021
@github-actions
Copy link
Contributor

github-actions bot commented May 1, 2021

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@gabegorelick
Copy link

It would be cool to implement it in the cloudwatch_logs plugin too

Is the eventual goal to implement record accessor in cloudwatch_logs, or to port the templating feature of cloudwatch into cloudwatch_logs?

aws/amazon-cloudwatch-logs-for-fluent-bit#131 (comment), mentions that cloudwatch didn't use record accessor because it's not available to Go plugins, but that's not an issue for cloudwatch_logs.

@PettitWesley
Copy link
Contributor

Is the eventual goal to implement record accessor in cloudwatch_logs

Yes. Record accessor is the Fluent Bit core way of doing templating. So we would use that method in cloudwatch_logs. The templating feature in the cloudwatch plugin works the way it does because it uses Go's templating library which unfortunately doesn't easily support the same syntax as record accessor.

@github-actions
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the Stale label Jun 12, 2021
@geckofu
Copy link

geckofu commented Jun 14, 2021

FWIW and to keep the issue open, aws-for-fluent-bit has both out_cloudwatch and out_cloudwatch_logs built in so you don't have to build the images yourself to use the templating functionality.

@github-actions
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@nnsense
Copy link

nnsense commented Aug 1, 2021

Hi there, I would ask a bit of priority for this if possible, the default fluent-bit image (using this repo as source) has only the cloudwatch_logs plugin and, in my case, redeploy the aws-for-fluent-bit just to get the old plugin would be a pain. Templating is the only way I've found to dynamically set cloudwatch logs names.

@PettitWesley since the docs are not stating the old plugin is deprecated, couldn't we temporarily have back the cloudwatch plugin, along the new one?

@gabegorelick
Copy link

couldn't we temporarily have back the cloudwatch plugin, along the new one?

You can use AWS's images: https:/aws/aws-for-fluent-bit

@PettitWesley
Copy link
Contributor

@PettitWesley since the docs are not stating the old plugin is deprecated, couldn't we temporarily have back the cloudwatch plugin, along the new one?

@nnsense what do you mean by "have back". The old cloudwatch plugin was never taken away 😬

@nnsense
Copy link

nnsense commented Aug 5, 2021

@PettitWesley
I mean that I cannot find it once deployed with https:/fluent/helm-charts/ which is using this repo, and I suppose that should be somewhere here https:/fluent/fluent-bit/tree/master/plugins, and I cannot find it, if I use cloudwatch as OUTPUT fluent-bit fails. Maybe I'm looking into the wrong place?

@PettitWesley
Copy link
Contributor

@nnsense that is because the cloudwatch plugin has never been in the core of fluent bit. Its always been an external go plugin in this repo only: https:/aws/amazon-cloudwatch-logs-for-fluent-bit

You can only use it if you are using AWS for Fluent Bit release, the upstream (this repo) release and helm charts will not include it: https:/aws/aws-for-fluent-bit

I think we have AWS for Fluent Bit helm charts here: https:/aws/eks-charts

@nnsense
Copy link

nnsense commented Aug 5, 2021

Got it, thanks. I just need to wait, basically, the whole story is rather interesting: aws-for-fluent-bit chart is currently using v1.7, so no multiline core. Latest image available for that chart is still 1.8.2, which has some bugs into its multiline core implementation. That works with 1.8.3 instead, but I can't use that image with aws-for-fluent-bit without rebuilding the image and.. its plugins are not public apparently :(
So I've started using fluent-bit chart with the 1.8.3 image and life was great.. until I've find out that record accessors aren't working yet with cloudwatch_logs 😁 Yeah, I know, the sweet and sour of open source. It's fine, thanks for the explanation, I'll use aws-for-fluent-bit using the old multiline until the new 1.8.3 will be used :)

@PettitWesley
Copy link
Contributor

@nnsense

That works with 1.8.3, but I can't use that image with aws-for-fluent-bit without rebuilding the image

We support 1.8.3 now:
https:/aws/aws-for-fluent-bit/releases/tag/v2.19.0

its plugins are not public apparently

What do you mean? Everything in AWS for FLuent Bit is public and open source. Nothing is closed source or hidden.

@nnsense
Copy link

nnsense commented Aug 6, 2021

Wow, that's great! When I've tried running docker build with the aws for fluent but Dockerfile I've got an authentication error at some point, I remember it was related some plugins but tomorrow I can try again and post the error, but it's not really important now that I have aws-for-fluent-bit working with 1.8.3 :)

@nnsense
Copy link

nnsense commented Aug 6, 2021

Ignore me, I've just checked and I've missed to use the makefile to build the plugins.. it has been a long day, that one :) (Also, I wasn't really happy of that path, as I should have used that custom image thereafter.. so I wasn't really convinced of what I was doing)

@julianogv
Copy link

julianogv commented Dec 16, 2021

I was able to achieve that by using

[OUTPUT]
        Name                cloudwatch
        Match               application.*
        region              ${AWS_REGION}
        log_group_name      /aws/containerinsights/${CLUSTER_NAME}/application/$(kubernetes['namespace_name'])/$(kubernetes['labels']['app'])

@PettitWesley
Copy link
Contributor

The cloudwatch plugin is our go plugin and it supports templating: https:/aws/amazon-cloudwatch-logs-for-fluent-bit#templating-log-group-and-stream-names

@PettitWesley
Copy link
Contributor

Finally working on this: #5633

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AWS Issues with AWS plugins or experienced by users running on AWS enhancement
Projects
None yet
Development

No branches or pull requests

6 participants