kbapi

Documentation

Overview

Package kbapi provides the GO API for Kibana

Index

• type API
  • func New(c *resty.Client) *API
• type APIError
  • func NewAPIError(code int, message string, params ...interface{}) APIError
  • func (e APIError) Error() string
• type KibanaDashboardAPI
• type KibanaDashboardExport
• type KibanaDashboardImport
• type KibanaLogstashPipelineAPI
• type KibanaLogstashPipelineCreateOrUpdate
• type KibanaLogstashPipelineDelete
• type KibanaLogstashPipelineGet
• type KibanaLogstashPipelineList
• type KibanaRole
  • func (k *KibanaRole) String() string
• type KibanaRoleElasticsearch
• type KibanaRoleElasticsearchIndice
• type KibanaRoleKibana
• type KibanaRoleManagementAPI
• type KibanaRoleManagementCreateOrUpdate
• type KibanaRoleManagementDelete
• type KibanaRoleManagementGet
• type KibanaRoleManagementList
• type KibanaRoleTransientMetadata
• type KibanaRoles
• type KibanaSavedObjectAPI
• type KibanaSavedObjectCreate
• type KibanaSavedObjectDelete
• type KibanaSavedObjectExport
• type KibanaSavedObjectFind
• type KibanaSavedObjectGet
• type KibanaSavedObjectImport
• type KibanaSavedObjectUpdate
• type KibanaShortenURLAPI
• type KibanaShortenURLCreate
• type KibanaSpace
  • func (k *KibanaSpace) String() string
• type KibanaSpaceCopySavedObjectParameter
• type KibanaSpaceCopySavedObjects
• type KibanaSpaceCreate
• type KibanaSpaceDelete
• type KibanaSpaceGet
• type KibanaSpaceList
• type KibanaSpaceObjectParameter
• type KibanaSpaceUpdate
• type KibanaSpaces
• type KibanaSpacesAPI
• type KibanaStatus
• type KibanaStatusAPI
• type KibanaStatusGet
• type LogstashPipeline
  • func (o *LogstashPipeline) String() string
• type LogstashPipelines
• type LogstashPipelinesList
• type OptionalFindParameters
  • func (o *OptionalFindParameters) String() string
• type ShortenURL
  • func (o *ShortenURL) String() string
• type ShortenURLResponse
  • func (o *ShortenURLResponse) String() string

Types

type API

type API struct {
	KibanaSpaces           *KibanaSpacesAPI
	KibanaRoleManagement   *KibanaRoleManagementAPI
	KibanaDashboard        *KibanaDashboardAPI
	KibanaSavedObject      *KibanaSavedObjectAPI
	KibanaStatus           *KibanaStatusAPI
	KibanaLogstashPipeline *KibanaLogstashPipelineAPI
	KibanaShortenURL       *KibanaShortenURLAPI
}

API handle the API specification

func New

func New(c *resty.Client) *API

New initialise the API implementation

type APIError

type APIError struct {
	Code    int
	Message string
}

APIError is the error object

func NewAPIError

func NewAPIError(code int, message string, params ...interface{}) APIError

NewAPIError create new API error with code and message

func (APIError) Error

func (e APIError) Error() string

Error return error message

type KibanaDashboardAPI

type KibanaDashboardAPI struct {
	Export KibanaDashboardExport
	Import KibanaDashboardImport
}

KibanaDashboardAPI handle the dashboard API

type KibanaDashboardExport

type KibanaDashboardExport func(listID []string, kibanaSpace string) (map[string]interface{}, error)

KibanaDashboardExport permit to export dashboard

type KibanaDashboardImport

type KibanaDashboardImport func(data map[string]interface{}, listExcludeType []string, force bool, kibanaSpace string) error

KibanaDashboardImport permit to import dashboard

type KibanaLogstashPipelineAPI

type KibanaLogstashPipelineAPI struct {
	Get            KibanaLogstashPipelineGet
	List           KibanaLogstashPipelineList
	CreateOrUpdate KibanaLogstashPipelineCreateOrUpdate
	Delete         KibanaLogstashPipelineDelete
}

KibanaLogstashPipelineAPI handle the logstash configuration management API

type KibanaLogstashPipelineCreateOrUpdate

type KibanaLogstashPipelineCreateOrUpdate func(logstashPipeline *LogstashPipeline) (*LogstashPipeline, error)

KibanaLogstashPipelineCreateOrUpdate permit to create or update logstash pipeline

type KibanaLogstashPipelineDelete

type KibanaLogstashPipelineDelete func(id string) error

KibanaLogstashPipelineDelete permit to delete the logstash pipeline

type KibanaLogstashPipelineGet

type KibanaLogstashPipelineGet func(id string) (*LogstashPipeline, error)

KibanaLogstashPipelineGet permit to get the logstash pipeline

type KibanaLogstashPipelineList

type KibanaLogstashPipelineList func() (LogstashPipelines, error)

KibanaLogstashPipelineList permit to get all the logstash pipeline

type KibanaRole

type KibanaRole struct {
	Name            string                       `json:"name,omitempty"`
	Metadata        map[string]interface{}       `json:"metadata,omitempty"`
	TransientMedata *KibanaRoleTransientMetadata `json:"transient_metadata,omitempty"`
	Elasticsearch   *KibanaRoleElasticsearch     `json:"elasticsearch,omitempty"`
	Kibana          []KibanaRoleKibana           `json:"kibana,omitempty"`
}

KibanaRole is the API role object

func (*KibanaRole) String

func (k *KibanaRole) String() string

String permit to return KibanaRole object as JSON string

type KibanaRoleElasticsearch

type KibanaRoleElasticsearch struct {
	Indices []KibanaRoleElasticsearchIndice `json:"indices,omitempty"`
	Cluster []string                        `json:"cluster,omitempty"`
	RunAs   []string                        `json:"run_as,omitempty"`
}

KibanaRoleElasticsearch is the API Elasticsearch object

type KibanaRoleElasticsearchIndice

type KibanaRoleElasticsearchIndice struct {
	Names         []string               `json:"names,omitempty"`
	Privileges    []string               `json:"privileges,omitempty"`
	FieldSecurity map[string]interface{} `json:"field_security,omitempty"`
	Query         interface{}            `json:"query,omitempty"`
}

KibanaRoleElasticsearchIndice is the API indice object

type KibanaRoleKibana

type KibanaRoleKibana struct {
	Base    []string            `json:"base,omitempty"`
	Feature map[string][]string `json:"feature,omitempty"`
	Spaces  []string            `json:"spaces,omitempty"`
}

KibanaRoleKibana is the API Kibana object

type KibanaRoleManagementAPI

type KibanaRoleManagementAPI struct {
	Get            KibanaRoleManagementGet
	List           KibanaRoleManagementList
	CreateOrUpdate KibanaRoleManagementCreateOrUpdate
	Delete         KibanaRoleManagementDelete
}

KibanaRoleManagementAPI handle the role management API

type KibanaRoleManagementCreateOrUpdate

type KibanaRoleManagementCreateOrUpdate func(kibanaRole *KibanaRole) (*KibanaRole, error)

KibanaRoleManagementCreateOrUpdate permit to create or update role in Kibana

type KibanaRoleManagementDelete

type KibanaRoleManagementDelete func(name string) error

KibanaRoleManagementDelete permit to delete role in Kibana

type KibanaRoleManagementGet

type KibanaRoleManagementGet func(name string) (*KibanaRole, error)

KibanaRoleManagementGet permit to get role from Kibana

type KibanaRoleManagementList

type KibanaRoleManagementList func() (KibanaRoles, error)

KibanaRoleManagementList permit to get all roles from Kibana

type KibanaRoleTransientMetadata

type KibanaRoleTransientMetadata struct {
	Enabled bool `json:"enabled,omitempty"`
}

KibanaRoleTransientMetadata is the API TransientMedata object

type KibanaRoles

type KibanaRoles []KibanaRole

KibanaRoles is a list of role object

type KibanaSavedObjectAPI

type KibanaSavedObjectAPI struct {
	Get    KibanaSavedObjectGet
	Find   KibanaSavedObjectFind
	Create KibanaSavedObjectCreate
	Update KibanaSavedObjectUpdate
	Delete KibanaSavedObjectDelete
	Import KibanaSavedObjectImport
	Export KibanaSavedObjectExport
}

KibanaSavedObjectAPI handle the saved object API

type KibanaSavedObjectCreate

type KibanaSavedObjectCreate func(data map[string]interface{}, objectType string, id string, overwrite bool, kibanaSpace string) (map[string]interface{}, error)

KibanaSavedObjectCreate permit to create saved object in Kibana

type KibanaSavedObjectDelete

type KibanaSavedObjectDelete func(objectType string, id string, kibanaSpace string) error

KibanaSavedObjectDelete permit to delete saved object in Kibana

type KibanaSavedObjectExport

type KibanaSavedObjectExport func(objectTypes []string, objects []map[string]string, deepReference bool, kibanaSpace string) (map[string]interface{}, error)

KibanaSavedObjectExport permit to export saved objects from Kibana

type KibanaSavedObjectFind

type KibanaSavedObjectFind func(objectType string, kibanaSpace string, optionalParameters *OptionalFindParameters) (map[string]interface{}, error)

KibanaSavedObjectFind permit to find saved objects from Kibana

type KibanaSavedObjectGet

type KibanaSavedObjectGet func(objectType string, id string, kibanaSpace string) (map[string]interface{}, error)

KibanaSavedObjectGet permit to get saved object from Kibana

type KibanaSavedObjectImport

type KibanaSavedObjectImport func(data []byte, overwrite bool, kibanaSpace string) (map[string]interface{}, error)

KibanaSavedObjectImport permit to import saved objects in Kibana

type KibanaSavedObjectUpdate

type KibanaSavedObjectUpdate func(data map[string]interface{}, objectType string, id string, kibanaSpace string) (map[string]interface{}, error)

KibanaSavedObjectUpdate permit to update saved object in Kibana

type KibanaShortenURLAPI

type KibanaShortenURLAPI struct {
	Create KibanaShortenURLCreate
}

KibanaShortenURLAPI handle the shorten URL API

type KibanaShortenURLCreate

type KibanaShortenURLCreate func(shortenURL *ShortenURL) (*ShortenURLResponse, error)

KibanaShortenURLCreate permit to create new shorten URL

type KibanaSpace

type KibanaSpace struct {
	ID               string   `json:"id"`
	Name             string   `json:"name"`
	Description      string   `json:"description,omitempty"`
	DisabledFeatures []string `json:"disabledFeatures,omitempty"`
	Reserved         bool     `json:"_reserved,omitempty"`
	Initials         string   `json:"initials,omitempty"`
	Color            string   `json:"color,omitempty"`
}

KibanaSpace is the Space API object

func (*KibanaSpace) String

func (k *KibanaSpace) String() string

String permit to return KibanaSpace object as JSON string

type KibanaSpaceCopySavedObjectParameter

type KibanaSpaceCopySavedObjectParameter struct {
	Spaces            []string                     `json:"spaces"`
	IncludeReferences bool                         `json:"includeReferences"`
	Overwrite         bool                         `json:"overwrite"`
	Objects           []KibanaSpaceObjectParameter `json:"objects"`
}

KibanaSpaceCopySavedObjectParameter is parameters to copy dashboard between spaces

type KibanaSpaceCopySavedObjects

type KibanaSpaceCopySavedObjects func(parameter *KibanaSpaceCopySavedObjectParameter, spaceOrigin string) error

KibanaSpaceCopySavedObjects permit to copy dashboad between space

type KibanaSpaceCreate

type KibanaSpaceCreate func(kibanaSpace *KibanaSpace) (*KibanaSpace, error)

KibanaSpaceCreate permit to create space

type KibanaSpaceDelete

type KibanaSpaceDelete func(id string) error

KibanaSpaceDelete permit to delete space

type KibanaSpaceGet

type KibanaSpaceGet func(id string) (*KibanaSpace, error)

KibanaSpaceGet permit to get space

type KibanaSpaceList

type KibanaSpaceList func() (KibanaSpaces, error)

KibanaSpaceList permit to get all spaces

type KibanaSpaceObjectParameter

type KibanaSpaceObjectParameter struct {
	Type string `json:"type"`
	ID   string `json:"id"`
}

KibanaSpaceObjectParameter is Object object

type KibanaSpaceUpdate

type KibanaSpaceUpdate func(kibanaSpace *KibanaSpace) (*KibanaSpace, error)

KibanaSpaceUpdate permit to update space

type KibanaSpaces

type KibanaSpaces []KibanaSpace

KibanaSpaces is the list of KibanaSpace object

type KibanaSpacesAPI

type KibanaSpacesAPI struct {
	Get              KibanaSpaceGet
	List             KibanaSpaceList
	Create           KibanaSpaceCreate
	Delete           KibanaSpaceDelete
	Update           KibanaSpaceUpdate
	CopySavedObjects KibanaSpaceCopySavedObjects
}

KibanaSpacesAPI handle the spaces API

type KibanaStatus

type KibanaStatus map[string]interface{}

KibanaStatus is the map of string that contain the API status

type KibanaStatusAPI

type KibanaStatusAPI struct {
	Get KibanaStatusGet
}

KibanaStatusAPI handle the status API

type KibanaStatusGet

type KibanaStatusGet func() (KibanaStatus, error)

KibanaStatusGet permit to get the current status of Kibana

type LogstashPipeline

type LogstashPipeline struct {
	ID          string                 `json:"id"`
	Description string                 `json:"description,omitempty"`
	Pipeline    string                 `json:"pipeline,omitempty"`
	Settings    map[string]interface{} `json:"settings,omitempty"`
	Username    string                 `json:"username,omitempty"`
}

LogstashPipeline is the Logstash pipeline object

func (*LogstashPipeline) String

func (o *LogstashPipeline) String() string

String permit to return LogstashPipeline object as JSON string

type LogstashPipelines

type LogstashPipelines []LogstashPipeline

LogstashPipelines is list of Logstash pipeline object

type LogstashPipelinesList

type LogstashPipelinesList struct {
	Pipelines LogstashPipelines `json:"pipelines"`
}

LogstashPipelinesList is the logstash pipeline list result when get the list

type OptionalFindParameters

type OptionalFindParameters struct {
	ObjectsPerPage        int
	Page                  int
	Search                string
	DefaultSearchOperator string
	SearchFields          []string
	Fields                []string
	SortField             string
	HasReference          string
}

OptionalFindParameters contain optional parameters to find objects

func (*OptionalFindParameters) String

func (o *OptionalFindParameters) String() string

String permit to return OptionalFindParameters object as JSON string

type ShortenURL

type ShortenURL struct {
	URL string `json:"url"`
}

ShortenURL is the shorten URL object

func (*ShortenURL) String

func (o *ShortenURL) String() string

String permit to return ShortenURL object as JSON string

type ShortenURLResponse

type ShortenURLResponse struct {
	ID string `json:"urlId"`
}

ShortenURLResponse is the shorten URL object response

func (*ShortenURLResponse) String

func (o *ShortenURLResponse) String() string

String permit to return ShortenURLResponse object as JSON string