xsc

Documentation

Index

• type XscServicesManager
  • func New(config config.Config) (*XscServicesManager, error)
  • func (sm *XscServicesManager) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error)
  • func (sm *XscServicesManager) Client() *jfroghttpclient.JfrogHttpClient
  • func (sm *XscServicesManager) Config() config.Config
  • func (sm *XscServicesManager) GetAnalyticsGeneralEvent(msi string) (*services.XscAnalyticsGeneralEvent, error)
  • func (sm *XscServicesManager) GetVersion() (string, error)
  • func (sm *XscServicesManager) SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error
  • func (sm *XscServicesManager) UpdateAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEventFinalize) error

Types

type XscServicesManager

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

XscServicesManager defines the http client and general configuration

func New

func New(config config.Config) (*XscServicesManager, error)

New creates a service manager to interact with Xsc

func (*XscServicesManager) AddAnalyticsGeneralEvent

func (sm *XscServicesManager) AddAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEvent) (string, error)

AddAnalyticsGeneralEvent will send an analytics metrics general event to Xsc and return MSI (multi scan id) generated by Xsc.

func (*XscServicesManager) Client

func (sm *XscServicesManager) Client() *jfroghttpclient.JfrogHttpClient

Client will return the http client

func (*XscServicesManager) Config

func (sm *XscServicesManager) Config() config.Config

func (*XscServicesManager) GetAnalyticsGeneralEvent

func (sm *XscServicesManager) GetAnalyticsGeneralEvent(msi string) (*services.XscAnalyticsGeneralEvent, error)

GetAnalyticsGeneralEvent returns general event that match the msi provided.

func (*XscServicesManager) GetVersion

func (sm *XscServicesManager) GetVersion() (string, error)

GetVersion will return the Xsc version

func (*XscServicesManager) SendXscLogErrorRequest

func (sm *XscServicesManager) SendXscLogErrorRequest(errorLog *services.ExternalErrorLog) error

func (*XscServicesManager) UpdateAnalyticsGeneralEvent

func (sm *XscServicesManager) UpdateAnalyticsGeneralEvent(event services.XscAnalyticsGeneralEventFinalize) error

UpdateAnalyticsGeneralEvent upon completion of the scan and we have all the results to report on, we send a finalized analytics metrics event with information matching an existing event's msi.