compass

README

Compass

Compass is a search and discovery engine built for querying application deployments, datasets and meta resources. It can also optionally track data flow relationships between these resources and allow the user to view a representation of the data flow graph.

Usage

sinks:
  name: compass
  config:
    host: https://compass.com
    headers:
      compass-User-Email: meteor@gotocompany.com
      Header-1: value11,value12
    labels:
      myCustom: $properties.attributes.myCustomField
      sampleLabel: $properties.labels.sampleLabelField

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Documentation

Index

• func New(c httpClient, logger log.Logger) plugins.Syncer
• type Asset
• type Config
• type LineageRecord
• type Owner
• type RequestPayload
• type Sink
  • func (s *Sink) Close() (err error)
  • func (s *Sink) Init(ctx context.Context, config plugins.Config) (err error)
  • func (s *Sink) Sink(ctx context.Context, batch []models.Record) (err error)

Functions

func New

func New(c httpClient, logger log.Logger) plugins.Syncer

Types

type Asset

type Asset struct {
	URN         string            `json:"urn"`
	Type        string            `json:"type"`
	Name        string            `json:"name"`
	Service     string            `json:"service"`
	Description string            `json:"description"`
	URL         string            `json:"url"`
	Owners      []Owner           `json:"owners"`
	Data        interface{}       `json:"data"`
	Labels      map[string]string `json:"labels"`
}

type Config

type Config struct {
	Host    string            `mapstructure:"host" validate:"required"`
	Headers map[string]string `mapstructure:"headers"`
	Labels  map[string]string `mapstructure:"labels"`
}

type LineageRecord

type LineageRecord struct {
	URN     string `json:"urn"`
	Type    string `json:"type"`
	Service string `json:"service"`
}

type Owner

type Owner struct {
	URN   string `json:"urn"`
	Name  string `json:"name"`
	Role  string `json:"role"`
	Email string `json:"email"`
}

type RequestPayload

type RequestPayload struct {
	Asset       Asset           `json:"asset"`
	Upstreams   []LineageRecord `json:"upstreams"`
	Downstreams []LineageRecord `json:"downstreams"`
}

type Sink

type Sink struct {
	plugins.BasePlugin
	// contains filtered or unexported fields
}

func (*Sink) Close

func (s *Sink) Close() (err error)

func (*Sink) Init

func (s *Sink) Init(ctx context.Context, config plugins.Config) (err error)

func (*Sink) Sink

func (s *Sink) Sink(ctx context.Context, batch []models.Record) (err error)