compass

package

v0.9.2 Latest Latest Go to latest Published: Sep 24, 2023 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/raystack/meteor

Links

Open Source Insights

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@raystack.io
      Header-1: value11,value12
    labels:
      myCustom: $attributes.myCustomField
      sampleLabel: $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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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            `json:"host" yaml:"host" mapstructure:"host" validate:"required"`
	Headers map[string]string `json:"headers" yaml:"headers" mapstructure:"headers"`
	Labels  map[string]string `json:"labels" yaml:"labels" 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 (*Sink) Close() error

func (*Sink) Init ¶

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

func (*Sink) Sink ¶

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL