@hackage / eventlog-live-otelcol

Stream eventlog data to the OpenTelemetry Collector.

0.6.0.0

About

Metadata

  • Last updated , by wenkokke
  • License BSD-3-Clause
  • Categories Systems Programming, Debugging
  • Maintained by: wen@well-typed.com

  • Lottery factor: 1

Links

Installation

Tested Compilers

  1. 9.10.2
  2. 9.8.4
  3. 9.6.7
  4. 9.4.8
  5. 9.2.8

Package Flags

Use the -f option with cabal commands to enable flags

    control (off by default)

    Enable control command server.

    use-eventlog-socket (off by default)

    Use eventlog-socket

    use-ghc-debug-stub (off by default)

    Use ghc-debug-stub

    use-template-haskell-lift (off by default)

    Use template-haskell-lift in place of template-haskell

Readme

This executable supports live streaming of eventlog data into the OpenTelemetry Collector.

Usage: eventlog-live-otelcol (--eventlog-stdin | --eventlog-file FILE | --eventlog-socket SOCKET)
                             [--eventlog-socket-timeout SECONDS]
                             [--eventlog-socket-exponent NUMBER]
                             [--eventlog-flush-interval SECONDS]
                             [--eventlog-log-file FILE]
                             [-h Tcmdyrbi]
                             [--service-name STRING]
                             [-v|--verbosity fatal|error|warning|info|debug|trace]
                             [-s|--stats]
                             [--config FILE]
                             --otelcol-host HOST
                             [--otelcol-port PORT]
                             [--otelcol-authority HOST]
                             [--otelcol-ssl]
                             [--otelcol-certificate-store FILE]
                             [--otelcol-ssl-key-log FILE | --otelcol-ssl-key-log-from-env]
                             [--control]
                             [--control-port PORT]
                             [--control-cors-allow-origin ORIGIN]
                             [--control-cors-max-age SECONDS]
                             [--control-cors-require-origin]
                             [--control-cors-ignore-failure]
                             [--my-eventlog-socket-unix FILE]
                             [--my-ghc-debug-socket | --my-ghc-debug-socket-unix FILE | --my-ghc-debug-socket-tcp ADDRESS]
                             [--print-defaults]
                             [--print-config-json-schema]

Available options:
  --eventlog-stdin                   Read the eventlog from stdin.
  --eventlog-file FILE               Read the eventlog from a file.
  --eventlog-socket SOCKET           Read the eventlog from a Unix socket.
  --eventlog-socket-timeout SECONDS  Eventlog socket connection retry timeout in seconds.
  --eventlog-socket-exponent NUMBER  Eventlog socket connection retry timeout exponent.
  --eventlog-flush-interval SECONDS  Eventlog flush interval in seconds.
                                     Should match the option passed to the application.
  --eventlog-log-file FILE           Use file to log binary eventlog data.
  -h Tcmdyrbi                        Heap profile breakdown.
                                     Should match the option passed to the application.
  --service-name STRING              The name of the profiled service.
  -v,--verbosity fatal|error|warning|info|debug|trace
                                     The severity threshold for logging.
  -s,--stats                         Display runtime statistics.
  --config FILE                      The path to a detailed configuration file.
  --print-defaults                   Print default configuration options.
  --print-config-json-schema         Print JSON Schema for configuration format.
  --help                             Show this help text.
  --version                          Show version information

OpenTelemetry Collector Server Options
  --otelcol-host HOST                Otelcol server hostname.
  --otelcol-port PORT                Otelcol server TCP port.
  --otelcol-authority HOST           Otelcol server authority.
  --otelcol-ssl                      Use SSL.
  --otelcol-certificate-store FILE   Store for certificate validation.
  --otelcol-ssl-key-log FILE         Use file to log SSL keys.
  --otelcol-ssl-key-log-from-env     Use SSLKEYLOGFILE to log SSL keys.

Control Server Options
  --control                          Start the control server.
  --control-port PORT                The port number for the control server.
  --control-cors-allow-origin ORIGIN Set the allowed origins for the control server CORS policy.
  --control-cors-max-age SECONDS     Set the maximum age of a cached CORS preflight request for the control server CORS policy.
  --control-cors-require-origin      If enabled, the control server will not accept requests without an Origin header.
  --control-cors-ignore-failure      If enabled, the control server will accept malformed CORS preflight requests.

Debug Options
  --my-eventlog-socket-unix FILE     Open an eventlog socket for this program on the given Unix socket.
  --my-ghc-debug-socket              Open the default ghc-debug socket for this program.
  --my-ghc-debug-socket-unix FILE    Open a ghc-debug Unix domain socket with the given file path.
  --my-ghc-debug-socket-tcp ADDRESS  Open a ghc-debug TCP/IP socket with the given address as 'host:port'.