cloudflarelogs

Documentation

Index

• func LogTypes() logtypes.Group
• type FirewallEvent
• type HTTPRequest
• type SpectrumEvent

Functions

func LogTypes

func LogTypes() logtypes.Group

Types

type FirewallEvent

type FirewallEvent struct {
	Action                 pantherlog.String                `json:"Action" description:"The code of the first-class action the Cloudflare Firewall took on this request"`
	ClientASN              pantherlog.Int64                 `json:"ClientASN" description:"The ASN number of the visitor"`
	ClientASNDescription   pantherlog.String                `json:"ClientASNDescription" description:"The ASN of the visitor as string"`
	ClientCountry          pantherlog.String                `json:"ClientCountry" description:"Country from which request originated"`
	ClientIP               pantherlog.String                `json:"ClientIP" panther:"ip" description:"The visitor's IP address (IPv4 or IPv6)"`
	ClientIPClass          pantherlog.String                `` /* 261-byte string literal not displayed */
	ClientRefererHost      pantherlog.String                `json:"ClientRefererHost" panther:"hostname" description:"The referer host"`
	ClientRefererPath      pantherlog.String                `json:"ClientRefererPath" description:"The referer path requested by visitor"`
	ClientRefererQuery     pantherlog.String                `json:"ClientRefererQuery" description:"The referer query-string was requested by the visitor"`
	ClientRefererScheme    pantherlog.String                `json:"ClientRefererScheme" description:"The referer url scheme requested by the visitor"`
	ClientRequestHost      pantherlog.String                `json:"ClientRequestHost" panther:"hostname" description:"The HTTP hostname requested by the visitor"`
	ClientRequestMethod    pantherlog.String                `json:"ClientRequestMethod" description:"The HTTP method used by the visitor"`
	ClientRequestPath      pantherlog.String                `json:"ClientRequestPath" description:"The path requested by visitor"`
	ClientRequestProtocol  pantherlog.String                `json:"ClientRequestProtocol" description:"The version of HTTP protocol requested by the visitor"`
	ClientRequestQuery     pantherlog.String                `json:"ClientRequestQuery" description:"The query-string was requested by the visitor"`
	ClientRequestScheme    pantherlog.String                `json:"ClientRequestScheme" description:"The url scheme requested by the visitor"`
	ClientRequestUserAgent pantherlog.String                `json:"ClientRequestUserAgent" description:"Visitor's user-agent string"`
	Datetime               pantherlog.Time                  `` /* 136-byte string literal not displayed */
	EdgeColoCode           pantherlog.String                `json:"EdgeColoCode" description:"The airport code of the Cloudflare datacenter that served this request"`
	EdgeResponseStatus     pantherlog.Int16                 `json:"EdgeResponseStatus" description:"HTTP response status code returned to browser"`
	Kind                   pantherlog.String                `json:"Kind" description:"The kind of event, currently only possible values are: firewall"`
	MatchIndex             pantherlog.Int64                 `json:"MatchIndex" description:"Rules match index in the chain"`
	Metadata               map[string]pantherlog.RawMessage `` /* 199-byte string literal not displayed */
	OriginResponseStatus   pantherlog.Int16                 `json:"OriginResponseStatus" description:"HTTP origin response status code returned to browser"`
	OriginatorRayID        pantherlog.String                `json:"OriginatorRayID" panther:"trace_id" description:"The RayID of the request that issued the challenge/jschallenge"`
	RayID                  pantherlog.String                `json:"RayID" panther:"trace_id" description:"The RayID of the request"`
	RuleID                 pantherlog.String                `json:"RuleID" description:"The Cloudflare security product-specific RuleID triggered by this request"`
	Source                 pantherlog.String                `json:"Source" description:"The Cloudflare security product triggered by this request"`
}

nolint:lll,maligned

type HTTPRequest

type HTTPRequest struct {
	BotScore                       pantherlog.Int64   `` /* 135-byte string literal not displayed */
	BotScoreSrc                    pantherlog.String  `` /* 208-byte string literal not displayed */
	CacheCacheStatus               pantherlog.String  `json:"CacheCacheStatus" description:"unknown | miss | expired | updating | stale | hit | ignored | bypass | revalidated"`
	CacheResponseBytes             pantherlog.Int64   `json:"CacheResponseBytes" description:"Number of bytes returned by the cache"`
	CacheResponseStatus            pantherlog.Int16   `` /* 185-byte string literal not displayed */
	CacheTieredFill                pantherlog.Bool    `json:"CacheTieredFill" description:"Tiered Cache was used to serve this request"`
	ClientASN                      pantherlog.Int64   `json:"ClientASN" description:"Client AS number"`
	ClientCountry                  pantherlog.String  `json:"ClientCountry" description:"Country of the client IP address"`
	ClientDeviceType               pantherlog.String  `json:"ClientDeviceType" description:"Client device type"`
	ClientIP                       pantherlog.String  `json:"ClientIP" panther:"ip" description:"IP address of the client"`
	ClientIPClass                  pantherlog.String  `` /* 192-byte string literal not displayed */
	ClientRequestBytes             pantherlog.Int64   `json:"ClientRequestBytes" description:"Number of bytes in the client request"`
	ClientRequestHost              pantherlog.String  `json:"ClientRequestHost" panther:"hostname" description:"Host requested by the client"`
	ClientRequestMethod            pantherlog.String  `json:"ClientRequestMethod" description:"HTTP method of client request"`
	ClientRequestPath              pantherlog.String  `json:"ClientRequestPath" description:"URI path requested by the client"`
	ClientRequestProtocol          pantherlog.String  `json:"ClientRequestProtocol" description:"HTTP protocol of client request"`
	ClientRequestReferer           pantherlog.String  `json:"ClientRequestReferer" panther:"hostname" description:"HTTP request referrer"`
	ClientRequestURI               pantherlog.String  `json:"ClientRequestURI" description:"URI requested by the client"`
	ClientRequestUserAgent         pantherlog.String  `json:"ClientRequestUserAgent" description:"User agent reported by the client"`
	ClientSSLProtocol              pantherlog.String  `json:"ClientSSLProtocol" description:"Client SSL (TLS) protocol"`
	ClientSrcPort                  pantherlog.Int32   `json:"ClientSrcPort" description:"Client source port"`
	ClientXRequestedWith           pantherlog.String  `json:"ClientXRequestedWith" description:"X-Requested-With HTTP header"`
	EdgeColoCode                   pantherlog.String  `json:"EdgeColoCode" description:"IATA airport code of data center that received the request"`
	EdgeColoID                     pantherlog.Int64   `json:"EdgeColoID" description:"Cloudflare edge colo id"`
	EdgeEndTimestamp               pantherlog.Time    `json:"EdgeEndTimestamp" tcodec:"cloudflare" description:"Timestamp at which the edge finished sending response to the client"`
	EdgePathingOp                  pantherlog.String  `` /* 126-byte string literal not displayed */
	EdgePathingSrc                 pantherlog.String  `` /* 138-byte string literal not displayed */
	EdgePathingStatus              pantherlog.String  `` /* 129-byte string literal not displayed */
	EdgeRateLimitAction            pantherlog.String  `json:"EdgeRateLimitAction" description:"The action taken by the blocking rule; empty if no action taken"`
	EdgeRateLimitID                pantherlog.String  `` /* 153-byte string literal not displayed */
	EdgeRequestHost                pantherlog.String  `json:"EdgeRequestHost" panther:"hostname" description:"Host header on the request from the edge to the origin"`
	EdgeResponseBytes              pantherlog.Int64   `json:"EdgeResponseBytes" description:"Number of bytes returned by the edge to the client"`
	EdgeResponseCompressionRatio   pantherlog.Float32 `json:"EdgeResponseCompressionRatio" description:"Edge response compression ratio"`
	EdgeResponseContentType        pantherlog.String  `json:"EdgeResponseContentType" description:"Edge response Content-Type header value"`
	EdgeResponseStatus             pantherlog.Int16   `json:"EdgeResponseStatus" description:"HTTP status code returned by Cloudflare to the client"`
	EdgeServerIP                   pantherlog.String  `json:"EdgeServerIP" panther:"ip" description:"IP of the edge server making a request to the origin"`
	EdgeStartTimestamp             pantherlog.Time    `` /* 158-byte string literal not displayed */
	FirewallMatchesActions         []string           `` /* 597-byte string literal not displayed */
	FirewallMatchesRuleIDs         []string           `` /* 292-byte string literal not displayed */
	FirewallMatchesSources         []string           `` /* 562-byte string literal not displayed */
	OriginIP                       pantherlog.String  `json:"OriginIP" panther:"ip" description:"IP of the origin server"`
	OriginResponseBytes            pantherlog.Int64   `json:"OriginResponseBytes" description:"Number of bytes returned by the origin server"`
	OriginResponseHTTPExpires      pantherlog.Time    `` /* 147-byte string literal not displayed */
	OriginResponseHTTPLastModified pantherlog.Time    `` /* 158-byte string literal not displayed */
	OriginResponseStatus           pantherlog.Int16   `json:"OriginResponseStatus" description:"Status returned by the origin server"`
	OriginResponseTime             pantherlog.Int64   `json:"OriginResponseTime" description:"Number of nanoseconds it took the origin to return the response to edge"`
	OriginSSLProtocol              pantherlog.String  `json:"OriginSSLProtocol" description:"SSL (TLS) protocol used to connect to the origin"`
	ParentRayID                    pantherlog.String  `` /* 127-byte string literal not displayed */
	RayID                          pantherlog.String  `json:"RayID" panther:"trace_id" description:"ID of the request"`
	SecurityLevel                  pantherlog.String  `` /* 163-byte string literal not displayed */
	WAFAction                      pantherlog.String  `json:"WAFAction" description:"Action taken by the WAF, if triggered"`
	WAFFlags                       pantherlog.String  `json:"WAFFlags" description:"Additional configuration flags: simulate (0x1) | null"`
	WAFMatchedVar                  pantherlog.String  `json:"WAFMatchedVar" description:"The full name of the most-recently matched variable"`
	WAFProfile                     pantherlog.String  `json:"WAFProfile" description:"low | med | high"`
	WAFRuleID                      pantherlog.String  `json:"WAFRuleID" description:"ID of the applied WAF rule"`
	WAFRuleMessage                 pantherlog.String  `json:"WAFRuleMessage" description:"Rule message associated with the triggered rule"`
	WorkerCPUTime                  pantherlog.Int64   `json:"WorkerCPUTime" description:"Amount of time in microseconds spent executing a worker, if any"`
	WorkerStatus                   pantherlog.String  `json:"WorkerStatus" description:"Status returned from worker daemon"`
	WorkerSubrequest               pantherlog.Bool    `json:"WorkerSubrequest" description:"Whether or not this request was a worker subrequest"`
	WorkerSubrequestCount          pantherlog.Int64   `json:"WorkerSubrequestCount" description:"Number of subrequests issued by a worker when handling this request"`
	ZoneID                         pantherlog.Int64   `json:"ZoneID" description:"Internal zone ID"`
}

nolint:lll,maligned

type SpectrumEvent

type SpectrumEvent struct {
	Application                    pantherlog.String `json:"Application" description:"The unique public ID of the application on which the event occurred"`
	ClientASN                      pantherlog.Int64  `json:"ClientASN" description:"Client AS number"`
	ClientBytes                    pantherlog.Int64  `json:"ClientBytes" description:"The number of bytes read from the client by the Spectrum service"`
	ClientCountry                  pantherlog.String `json:"ClientCountry" description:"Country of the client IP address"`
	ClientIP                       pantherlog.String `json:"ClientIP" panther:"ip" description:"IP address of the client"`
	ClientMatchedIPFirewall        pantherlog.String `` /* 217-byte string literal not displayed */
	ClientPort                     pantherlog.Uint16 `json:"ClientPort" description:"Client port"`
	ClientProto                    pantherlog.String `json:"ClientProto" description:"Transport protocol used by client; tcp | udp | unix"`
	ClientTCPRtt                   pantherlog.Int64  `json:"ClientTcpRtt" description:"The TCP round-trip time in nanoseconds between the client and Spectrum"`
	ClientTLSCipher                pantherlog.String `json:"ClientTlsCipher" description:"The cipher negotiated between the client and Spectrum"`
	ClientTLSClientHelloServerName pantherlog.String `json:"ClientTlsClientHelloServerName" description:"The server name in the Client Hello message from client to Spectrum"`
	ClientTLSProtocol              pantherlog.String `` /* 159-byte string literal not displayed */
	ClientTLSStatus                pantherlog.String `` /* 190-byte string literal not displayed */
	ColoCode                       pantherlog.String `json:"ColoCode" description:"IATA airport code of data center that received the request"`
	ConnectTimestamp               pantherlog.Time   `` /* 159-byte string literal not displayed */
	DisconnectTimestamp            pantherlog.Time   `json:"DisconnectTimestamp" tcodec:"cloudflare" description:"Timestamp at which the connection was closed"`
	Event                          pantherlog.String `json:"Event" description:"connect | disconnect | clientFiltered | tlsError | resolveOrigin | originError"`
	IPFirewall                     pantherlog.Bool   `json:"IpFirewall" description:"Whether IP Firewall was enabled at time of connection"`
	OriginBytes                    pantherlog.Int64  `json:"OriginBytes" description:"The number of bytes read from the origin by Spectrum"`
	OriginIP                       pantherlog.String `json:"OriginIP" panther:"ip" description:"Origin IP address"`
	OriginPort                     pantherlog.Uint16 `json:"OriginPort" description:"Origin port"`
	OriginProto                    pantherlog.String `json:"OriginProto" description:"Transport protocol used by origin; tcp | udp | unix"`
	OriginTCPRtt                   pantherlog.Int64  `json:"OriginTcpRtt" description:"The TCP round-trip time in nanoseconds between Spectrum and the origin"`
	OriginTLSCipher                pantherlog.String `json:"OriginTlsCipher" description:"The cipher negotiated between Spectrum and the origin"`
	OriginTLSFingerprint           pantherlog.String `json:"OriginTlsFingerprint" description:"SHA256 hash of origin certificate"`
	OriginTLSMode                  pantherlog.String `json:"OriginTlsMode" description:"If and how the upstream connection is encrypted; unknown | off | flexible | full | strict"`
	OriginTLSProtocol              pantherlog.String `` /* 159-byte string literal not displayed */
	OriginTLSStatus                pantherlog.String `` /* 188-byte string literal not displayed */
	ProxyProtocol                  pantherlog.String `json:"ProxyProtocol" description:"Which form of proxy protocol is applied to the given connection; off | v1 | v2 | simple"`
	Status                         pantherlog.Int64  `json:"Status" description:"A code indicating reason for connection closure"`
	Timestamp                      pantherlog.Time   `` /* 128-byte string literal not displayed */
}

nolint:lll,maligned