https://github.com/drdaeman/logdna-logrus

LogDNA Logrus and Logrus Mate library
https://github.com/drdaeman/logdna-logrus

go golang golang-library logdna logging logrus-hook

Last synced: about 1 year ago
JSON representation

LogDNA Logrus and Logrus Mate library

• Host: GitHub
• URL: https://github.com/drdaeman/logdna-logrus
• Owner: drdaeman
• License: mit
• Created: 2017-12-04T20:25:04.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-07-17T21:47:33.000Z (almost 6 years ago)
• Last Synced: 2025-02-05T00:46:34.651Z (over 1 year ago)
• Topics: go, golang, golang-library, logdna, logging, logrus-hook
• Language: Go
• Size: 25.4 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
LogDNA Logrus and Logrus Mate library

=====================================

[![Go Report Card][grc-badge]][grc]

This library allows logging to [LogDNA][logdna] from [Logrus][logrus],

optionally configuring everything using [Logrus Mate][mate].

This library is not currently actively maintained.

Configuration

-------------

Check out the `example/` subdirectory for a simple example.

You can create hook manually, `New` method or using Logrus Mate.

For HOCON configuration provider (the default), add a hook like this:

    your-logger {

        ...

        hooks {

            logdna {

                api-key = "your-ingestion-key-here"

                app = "myapp"

                json = true

            }

            ...

        }

        ...

    }

The supported options are:

  - `api-key`: ingestion key, mandatory

  - `hostname`: hostname override, if not specified will use `os.Hostname()`

  - `mac`: host MAC address, not sent if empty, no autodetection for now

  - `ip`: host IP address, ditto

  - `app`: app identifier, for LogDNA to filter

  - `env`: environment identifier, for LogDNA to filter

  - `size`: buffer size, in entries, defaults to 4096

  - `flush`: flush interval, defaults to 10 seconds

  - `qsize`: buffered channel size

  - `drop`: whenever hook's allowed to drop messages (if buffer's full etc).

    Logging will block if this is false and there are size+qsize entries

    waiting to be sent.

  - `json`: how to send structured log fields. Will format line as JSON if set

    to true (using `"message"` key for log message), or pass fields as `meta`

    if not.

  - `text-format`: whenever to also include structured logging data in the

    message. Default to false, enabling will append key-value pairs to

    the message texts, so they'll be immediately visible.

  - `url` allows to override the ignestion endpoint URL (e.g. for testing)

With `New` method and `Config` struct you have a little more flexibility,

as you can specify any `MessageFormatter` rather than just `text-format`.

Limitations

-----------

As the logging is asynchronous, error handling is limited.

If `drop` is set to true, you can lose messages on outages.

If `drop` is false, program may panic at shutdown, or buffer size

may grow past the `size` limit.

Also, to give the hooks chance flush before the program exits,

don't forget to add `defer logrus.Exit(0)` to your `main`.

Suggestions (and pull requests) are welcomed.

[logdna]: https://logdna.com

[logrus]: https://github.com/sirupsen/logrus

[mate]: https://github.com/gogap/logrus_mate

[grc-badge]: https://goreportcard.com/badge/github.com/drdaeman/logdna-logrus

[grc]: https://goreportcard.com/report/github.com/drdaeman/logdna-logrus