apex

README

Axiom Go Adapter for apex/log

Adapter to ship logs generated by apex/log to Axiom.

Quickstart

Follow the Axiom Go Quickstart to install the Axiom Go package and configure your environment.

Import the package:

// Imported as "adapter" to not conflict with the "apex/log" package.
import adapter "github.com/axiomhq/axiom-go/adapters/apex"

You can also configure the adapter using options passed to the New function:

handler, err := adapter.New(
    adapter.SetDataset("AXIOM_DATASET"),
)

To configure the underlying client manually either pass in a client that was created according to the Axiom Go Quickstart using SetClient or pass client options to the adapter using SetClientOptions.

import (
    "github.com/axiomhq/axiom-go/axiom"
    adapter "github.com/axiomhq/axiom-go/adapters/apex"
)

// ...

handler, err := adapter.New(
    adapter.SetClientOptions(
        axiom.SetPersonalTokenConfig("AXIOM_TOKEN", "AXIOM_ORG_ID"),
    ),
)

[!IMPORTANT] The adapter uses a buffer to batch events before sending them to Axiom. This buffer must be flushed explicitly by calling Close. Checkout out the example.

Documentation

Overview

Package apex provides an adapter for the popular github.com/apex/log logging library.

Example

package main

import (
	"github.com/apex/log"

	adapter "github.com/axiomhq/axiom-go/adapters/apex"
)

func main() {
	// Export "AXIOM_DATASET" in addition to the required environment variables.

	handler, err := adapter.New()
	if err != nil {
		log.Fatal(err.Error())
	}
	defer handler.Close()

	log.SetHandler(handler)

	log.WithField("mood", "hyped").Info("This is awesome!")
	log.WithField("mood", "worried").Warn("This is no that awesome...")
	log.WithField("mood", "depressed").Error("This is rather bad.")
}

Index

• Variables
• type Handler
  • func New(options ...Option) (*Handler, error)
  • func (h *Handler) Close()
  • func (h *Handler) HandleLog(entry *log.Entry) error
• type Option
  • func SetClient(client *axiom.Client) Option
  • func SetClientOptions(options ...axiom.Option) Option
  • func SetDataset(datasetName string) Option
  • func SetIngestOptions(opts ...ingest.Option) Option

Examples

• Package

Variables

var ErrMissingDatasetName = errors.New("missing dataset name")

ErrMissingDatasetName is raised when a dataset name is not provided. Set it manually using the SetDataset option or export "AXIOM_DATASET".

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler implements a log.Handler used for shipping logs to Axiom.

func New

func New(options ...Option) (*Handler, error)

New creates a new handler that ingests logs into Axiom. It automatically takes its configuration from the environment. To connect, export the following environment variables:

• AXIOM_TOKEN
• AXIOM_ORG_ID (only when using a personal token)
• AXIOM_DATASET

The configuration can be set manually using options which are prefixed with "Set".

An API token with "ingest" permission is sufficient enough.

A handler needs to be closed properly to make sure all logs are sent by calling Handler.Close.

func (*Handler) Close

func (h *Handler) Close()

Close the handler and make sure all events are flushed. Closing the handler renders it unusable for further use.

func (*Handler) HandleLog

func (h *Handler) HandleLog(entry *log.Entry) error

HandleLog implements log.Handler.

type Option

type Option func(*Handler) error

An Option modifies the behaviour of the Axiom handler.

func SetClient

func SetClient(client *axiom.Client) Option

SetClient specifies the Axiom client to use for ingesting the logs.

func SetClientOptions

func SetClientOptions(options ...axiom.Option) Option

SetClientOptions specifies the Axiom client options to pass to axiom.NewClient which is only called if no axiom.Client was specified by the SetClient option.

func SetDataset

func SetDataset(datasetName string) Option

SetDataset specifies the dataset to ingest the logs into. Can also be specified using the "AXIOM_DATASET" environment variable.

func SetIngestOptions

func SetIngestOptions(opts ...ingest.Option) Option

SetIngestOptions specifies the ingestion options to use for ingesting the logs.