definitions.go

package transaction

import "github.com/Axway/agent-sdk/pkg/transaction/models"

// TypeTransactionSummary - Transaction summary type
const TypeTransactionSummary = "transactionSummary"

// TypeTransactionEvent - Transaction Event type
const TypeTransactionEvent = "transactionEvent"

// SummaryEventProxyIDPrefix - Prefix for proxyID in summary event
const SummaryEventProxyIDPrefix = "remoteApiId_"

// SummaryEventApplicationIDPrefix - Prefix for application.ID in summary event
const SummaryEventApplicationIDPrefix = "remoteAppId_"

// TxEventStatus - Type def for transaction event status
type TxEventStatus string

// Constants for transaction event status
const (
	// TxEventStatusPass - Constant for Pass transaction event status
	TxEventStatusPass TxEventStatus = "Pass"

	// TxEventStatusFail - Constant for Fail transaction event status
	TxEventStatusFail TxEventStatus = "Fail"
)

// TxSummaryStatus - Type def for transaction event status
type TxSummaryStatus string

// Constants for transaction summary status
const (
	// TxSummaryStatusSuccess - Constant for Success transaction summary status
	TxSummaryStatusSuccess TxSummaryStatus = "Success"

	// TxSummaryStatusFailure - Constant for Success transaction summary status
	TxSummaryStatusFailure TxSummaryStatus = "Failure"

	// TxSummaryStatusException - Constant for Exception transaction summary status
	TxSummaryStatusException TxSummaryStatus = "Exception"

	// TxSummaryStatusUnknown - Constant for Exception transaction summary status
	TxSummaryStatusUnknown TxSummaryStatus = "Unknown"
)

const (
	unknown = "unknown"
)

// LogEvent - Log event to be sent to Condor
type LogEvent struct {
	Version            string   `json:"version"`
	Stamp              int64    `json:"timestamp"`
	TransactionID      string   `json:"transactionId"`
	Environment        string   `json:"environment,omitempty"`
	APICDeployment     string   `json:"apicDeployment,omitempty"`
	EnvironmentName    string   `json:"environmentName,omitempty"`
	EnvironmentID      string   `json:"environmentId"`
	TenantID           string   `json:"tenantId"`
	TrcbltPartitionID  string   `json:"trcbltPartitionId"`
	Type               string   `json:"type"`
	TargetPath         string   `json:"targetPath,omitempty"`
	ResourcePath       string   `json:"resourcePath,omitempty"`
	TransactionEvent   *Event   `json:"transactionEvent,omitempty"`
	TransactionSummary *Summary `json:"transactionSummary,omitempty"`
}

// Summary - Represent the transaction summary event
type Summary struct {
	Status          string                  `json:"status,omitempty"`
	StatusDetail    string                  `json:"statusDetail,omitempty"`
	Duration        int                     `json:"duration"`
	Team            *Team                   `json:"team,omitempty"`
	Proxy           *Proxy                  `json:"proxy,omitempty"`
	Runtime         *Runtime                `json:"runtime,omitempty"`
	EntryPoint      *EntryPoint             `json:"entryPoint,omitempty"`
	IsInMetricEvent bool                    `json:"isInMetricEvent,omitempty"`
	Application     *Application            `json:"application,omitempty"`
	AssetResource   *models.AssetResource   `json:"assetResource,omitempty"`
	API             *models.APIDetails      `json:"api,omitempty"`
	Product         *models.Product         `json:"product,omitempty"`
	ProductPlan     *models.ProductPlan     `json:"productPlan,omitempty"`
	Quota           *models.Quota           `json:"quota,omitempty"`
	ConsumerDetails *models.ConsumerDetails `json:"consumerDetails,omitempty"`
}

// Application  - Represents the application used in transaction summary event (dataplane)
type Application struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

// Team  - Represents the team used in transaction summary event
type Team struct {
	ID string `json:"id,omitempty"`
}

// Proxy - Represents the proxy definition in summary event
type Proxy struct {
	ID       string `json:"id,omitempty"`
	Revision int    `json:"revision,omitempty"`
	Name     string `json:"name,omitempty"`
	Stage    string `json:"-"`
	Version  string `json:"-"`
}

// Runtime - Represents the runtime group details if applicable in summary event
type Runtime struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

// EntryPoint - represents the entry point details for API in summary event
type EntryPoint struct {
	Type   string `json:"type,omitempty"`
	Method string `json:"method,omitempty"`
	Path   string `json:"path,omitempty"`
	Host   string `json:"host,omitempty"`
}

// TransportProtocol - Interface for transport protocol detail
type TransportProtocol interface{}

// Event - Represents the transaction detail event
type Event struct {
	ID          string            `json:"id,omitempty"`
	ParentID    string            `json:"parentId,omitempty"`
	Source      string            `json:"source,omitempty"`
	Destination string            `json:"destination,omitempty"`
	Duration    int               `json:"duration"`
	Direction   string            `json:"direction,omitempty"`
	Status      string            `json:"status,omitempty"`
	Protocol    TransportProtocol `json:"protocol,omitempty"`
}

// Protocol - Represents the protocol details in transaction detail events
type Protocol struct {
	Type                   string `json:"type,omitempty"`
	URI                    string `json:"uri,omitempty"`
	Args                   string `json:"args,omitempty"`
	Method                 string `json:"method,omitempty"`
	Status                 int    `json:"status,omitempty"`
	StatusText             string `json:"statusText,omitempty"`
	UserAgent              string `json:"userAgent,omitempty"`
	Host                   string `json:"host,omitempty"`
	Version                string `json:"version,omitempty"`
	BytesReceived          int    `json:"bytesReceived,omitempty"`
	BytesSent              int    `json:"bytesSent,omitempty"`
	RemoteName             string `json:"remoteName,omitempty"`
	RemoteAddr             string `json:"remoteAddr,omitempty"`
	RemotePort             int    `json:"remotePort,omitempty"`
	LocalAddr              string `json:"localAddr,omitempty"`
	LocalPort              int    `json:"localPort,omitempty"`
	SslServerName          string `json:"sslServerName,omitempty"`
	SslProtocol            string `json:"sslProtocol,omitempty"`
	Referer                string `json:"referer,omitempty"`
	SslSubject             string `json:"sslSubject,omitempty"`
	AuthSubjectID          string `json:"authSubjectId,omitempty"`
	RequestHeaders         string `json:"requestHeaders,omitempty"`
	IndexedRequestHeaders  string `json:"indexedRequestHeaders,omitempty"`
	ResponseHeaders        string `json:"responseHeaders,omitempty"`
	IndexedResponseHeaders string `json:"indexedResponseHeaders,omitempty"`
	RequestPayload         string `json:"requestPayload,omitempty"`
	ResponsePayload        string `json:"responsePayload,omitempty"`
	WafStatus              int    `json:"wafStatus,omitempty"`
	Timing                 string `json:"timing,omitempty"`
	uriRaw                 string
}