Documentation
¶
Index ¶
- Constants
- func CreateAnalyticsEvent(product xscservices.ProductName, eventType xscservices.EventType, ...) *xscservices.XscAnalyticsGeneralEvent
- func CreateFinalizedEvent(xrayVersion, multiScanId string, startTime time.Time, totalFindings int, ...) xscservices.XscAnalyticsGeneralEventFinalize
- func CreateXscService(serviceDetails *config.ServerDetails, options ...xray.XrayManagerOption) (*xscservices.XscInnerService, error)
- func CreateXscServiceBackwardCompatible(xrayVersion string, serviceDetails *config.ServerDetails, ...) (xsc.XscService, error)
- func GetConfigProfileByName(xrayVersion string, serverDetails *config.ServerDetails, ...) (*services.ConfigProfile, error)
- func GetConfigProfileByUrl(xrayVersion string, serverDetails *config.ServerDetails, cloneRepoUrl string) (*services.ConfigProfile, error)
- func GetJfrogServicesVersion(serverDetails *config.ServerDetails) (xrayVersion, xscVersion string, err error)
- func GetScanEvent(xrayVersion, xscVersion, multiScanId string, ...) (*xscservices.XscAnalyticsGeneralEvent, error)
- func IsReportLogErrorEventPossible(xscVersion string) bool
- func ReportError(xrayVersion, xscVersion string, serverDetails *config.ServerDetails, ...) error
- func SendGitIntegrationEvent(serverDetails *config.ServerDetails, ...) error
- func SendNewScanEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, ...) (multiScanId string, startTime time.Time)
- func SendScanEndedEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, ...)
- func SendScanEndedWithResults(serviceDetails *config.ServerDetails, ...)
Constants ¶
View Source
const MinXscVersionForErrorReport = "1.7.7"
Variables ¶
This section is empty.
Functions ¶
func CreateAnalyticsEvent ¶ added in v1.13.2
func CreateAnalyticsEvent(product xscservices.ProductName, eventType xscservices.EventType, serviceDetails *config.ServerDetails) *xscservices.XscAnalyticsGeneralEvent
func CreateFinalizedEvent ¶ added in v1.13.2
func CreateFinalizedEvent(xrayVersion, multiScanId string, startTime time.Time, totalFindings int, resultsContext *results.ResultContext, err error) xscservices.XscAnalyticsGeneralEventFinalize
func CreateXscService ¶ added in v1.13.2
func CreateXscService(serviceDetails *config.ServerDetails, options ...xray.XrayManagerOption) (*xscservices.XscInnerService, error)
func CreateXscServiceBackwardCompatible ¶ added in v1.14.0
func CreateXscServiceBackwardCompatible(xrayVersion string, serviceDetails *config.ServerDetails, options ...xray.XrayManagerOption) (xsc.XscService, error)
func GetConfigProfileByName ¶ added in v1.13.6
func GetConfigProfileByName(xrayVersion string, serverDetails *config.ServerDetails, profileName, projectKey string) (*services.ConfigProfile, error)
func GetConfigProfileByUrl ¶ added in v1.13.6
func GetConfigProfileByUrl(xrayVersion string, serverDetails *config.ServerDetails, cloneRepoUrl string) (*services.ConfigProfile, error)
func GetJfrogServicesVersion ¶ added in v1.13.5
func GetJfrogServicesVersion(serverDetails *config.ServerDetails) (xrayVersion, xscVersion string, err error)
func GetScanEvent ¶ added in v1.13.2
func GetScanEvent(xrayVersion, xscVersion, multiScanId string, serviceDetails *config.ServerDetails, projectKey string) (*xscservices.XscAnalyticsGeneralEvent, error)
func IsReportLogErrorEventPossible ¶
Determines if reporting the error is feasible.
func ReportError ¶
func ReportError(xrayVersion, xscVersion string, serverDetails *config.ServerDetails, errorToReport error, source, projectKey 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.
func SendGitIntegrationEvent ¶ added in v1.24.1
func SendGitIntegrationEvent(serverDetails *config.ServerDetails, xrayVersion, projectKey, eventType, gitProvider, gitOwner, gitRepository, gitBranch, eventStatus, failureReason string) error
func SendNewScanEvent ¶ added in v1.13.2
func SendNewScanEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, event *xscservices.XscAnalyticsGeneralEvent, projectKey string) (multiScanId string, startTime time.Time)
func SendScanEndedEvent ¶ added in v1.13.2
func SendScanEndedEvent(xrayVersion, xscVersion string, serviceDetails *config.ServerDetails, multiScanId string, startTime time.Time, totalFindings int, resultsContext *results.ResultContext, scanError error)
func SendScanEndedWithResults ¶ added in v1.13.2
func SendScanEndedWithResults(serviceDetails *config.ServerDetails, cmdResults *results.SecurityCommandResults)
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.