Documentation ¶
Index ¶
- Constants
- func CreateXscServiceManager(serviceDetails *config.ServerDetails) (*xsc.XscServicesManager, error)
- func GetConfigProfile(serverDetails *config.ServerDetails, profileName string) (*services.ConfigProfile, error)
- func GetXscMsiAndVersion(analyticsMetricsService *AnalyticsMetricsService) (multiScanId, xscVersion string)
- func IsReportLogErrorEventPossible(xscManager *xsc.XscServicesManager) bool
- func ReportError(serverDetails *config.ServerDetails, errorToReport error, source string) error
- type AnalyticsMetricsService
- func (ams *AnalyticsMetricsService) AddGeneralEvent(event *xscservices.XscAnalyticsGeneralEvent)
- func (ams *AnalyticsMetricsService) AddScanFindingsToXscAnalyticsGeneralEventFinalize(findingsAmount int)
- func (ams *AnalyticsMetricsService) CreateGeneralEvent(product xscservices.ProductName, eventType xscservices.EventType) *xscservices.XscAnalyticsGeneralEvent
- func (ams *AnalyticsMetricsService) CreateXscAnalyticsGeneralEventFinalizeFromAuditResults(auditResults *results.SecurityCommandResults) *xscservices.XscAnalyticsGeneralEventFinalize
- func (ams *AnalyticsMetricsService) FinalizeEvent() *xscservices.XscAnalyticsGeneralEventFinalize
- func (ams *AnalyticsMetricsService) GetGeneralEvent(msi string) (*xscservices.XscAnalyticsGeneralEvent, error)
- func (ams *AnalyticsMetricsService) GetMsi() string
- func (ams *AnalyticsMetricsService) GetStartTime() time.Time
- func (ams *AnalyticsMetricsService) SetFinalizeEvent(finalizeEvent *xscservices.XscAnalyticsGeneralEventFinalize)
- func (ams *AnalyticsMetricsService) SetMsi(msi string)
- func (ams *AnalyticsMetricsService) SetShouldReportEvents(shouldReportEvents bool)
- func (ams *AnalyticsMetricsService) SetStartTime()
- func (ams *AnalyticsMetricsService) ShouldReportEvents() bool
- func (ams *AnalyticsMetricsService) UpdateAndSendXscAnalyticsGeneralEventFinalize(err error)
- func (ams *AnalyticsMetricsService) UpdateGeneralEvent(event *xscservices.XscAnalyticsGeneralEventFinalize)
- func (ams *AnalyticsMetricsService) UpdateXscAnalyticsGeneralEventFinalizeStatus(status xscservices.EventStatus)
- func (ams *AnalyticsMetricsService) UpdateXscAnalyticsGeneralEventFinalizeWithTotalScanDuration()
- func (ams *AnalyticsMetricsService) XscManager() *xsc.XscServicesManager
Constants ¶
View Source
const MinXscVersionForErrorReport = "1.7.7"
Variables ¶
This section is empty.
Functions ¶
func CreateXscServiceManager ¶
func CreateXscServiceManager(serviceDetails *config.ServerDetails) (*xsc.XscServicesManager, error)
func GetConfigProfile ¶ added in v1.8.0
func GetConfigProfile(serverDetails *config.ServerDetails, profileName string) (*services.ConfigProfile, error)
func GetXscMsiAndVersion ¶ added in v1.7.0
func GetXscMsiAndVersion(analyticsMetricsService *AnalyticsMetricsService) (multiScanId, xscVersion string)
func IsReportLogErrorEventPossible ¶
func IsReportLogErrorEventPossible(xscManager *xsc.XscServicesManager) bool
Determines if reporting the error is feasible.
func ReportError ¶
func ReportError(serverDetails *config.ServerDetails, errorToReport error, source string) error
Sends an error report when the Xsc service is enabled. Errors returned by this function typically do not disrupt the flow, as reporting errors is optional.
Types ¶
type AnalyticsMetricsService ¶
type AnalyticsMetricsService struct {
// contains filtered or unexported fields
}
func NewAnalyticsMetricsService ¶
func NewAnalyticsMetricsService(serviceDetails *config.ServerDetails) *AnalyticsMetricsService
func (*AnalyticsMetricsService) AddGeneralEvent ¶
func (ams *AnalyticsMetricsService) AddGeneralEvent(event *xscservices.XscAnalyticsGeneralEvent)
func (*AnalyticsMetricsService) AddScanFindingsToXscAnalyticsGeneralEventFinalize ¶
func (ams *AnalyticsMetricsService) AddScanFindingsToXscAnalyticsGeneralEventFinalize(findingsAmount int)
func (*AnalyticsMetricsService) CreateGeneralEvent ¶
func (ams *AnalyticsMetricsService) CreateGeneralEvent(product xscservices.ProductName, eventType xscservices.EventType) *xscservices.XscAnalyticsGeneralEvent
func (*AnalyticsMetricsService) CreateXscAnalyticsGeneralEventFinalizeFromAuditResults ¶
func (ams *AnalyticsMetricsService) CreateXscAnalyticsGeneralEventFinalizeFromAuditResults(auditResults *results.SecurityCommandResults) *xscservices.XscAnalyticsGeneralEventFinalize
func (*AnalyticsMetricsService) FinalizeEvent ¶
func (ams *AnalyticsMetricsService) FinalizeEvent() *xscservices.XscAnalyticsGeneralEventFinalize
func (*AnalyticsMetricsService) GetGeneralEvent ¶
func (ams *AnalyticsMetricsService) GetGeneralEvent(msi string) (*xscservices.XscAnalyticsGeneralEvent, error)
func (*AnalyticsMetricsService) GetMsi ¶
func (ams *AnalyticsMetricsService) GetMsi() string
func (*AnalyticsMetricsService) GetStartTime ¶
func (ams *AnalyticsMetricsService) GetStartTime() time.Time
func (*AnalyticsMetricsService) SetFinalizeEvent ¶
func (ams *AnalyticsMetricsService) SetFinalizeEvent(finalizeEvent *xscservices.XscAnalyticsGeneralEventFinalize)
func (*AnalyticsMetricsService) SetMsi ¶
func (ams *AnalyticsMetricsService) SetMsi(msi string)
func (*AnalyticsMetricsService) SetShouldReportEvents ¶
func (ams *AnalyticsMetricsService) SetShouldReportEvents(shouldReportEvents bool)
func (*AnalyticsMetricsService) SetStartTime ¶
func (ams *AnalyticsMetricsService) SetStartTime()
func (*AnalyticsMetricsService) ShouldReportEvents ¶
func (ams *AnalyticsMetricsService) ShouldReportEvents() bool
func (*AnalyticsMetricsService) UpdateAndSendXscAnalyticsGeneralEventFinalize ¶
func (ams *AnalyticsMetricsService) UpdateAndSendXscAnalyticsGeneralEventFinalize(err error)
func (*AnalyticsMetricsService) UpdateGeneralEvent ¶
func (ams *AnalyticsMetricsService) UpdateGeneralEvent(event *xscservices.XscAnalyticsGeneralEventFinalize)
func (*AnalyticsMetricsService) UpdateXscAnalyticsGeneralEventFinalizeStatus ¶
func (ams *AnalyticsMetricsService) UpdateXscAnalyticsGeneralEventFinalizeStatus(status xscservices.EventStatus)
func (*AnalyticsMetricsService) UpdateXscAnalyticsGeneralEventFinalizeWithTotalScanDuration ¶
func (ams *AnalyticsMetricsService) UpdateXscAnalyticsGeneralEventFinalizeWithTotalScanDuration()
func (*AnalyticsMetricsService) XscManager ¶
func (ams *AnalyticsMetricsService) XscManager() *xsc.XscServicesManager
Click to show internal directories.
Click to hide internal directories.