Instance methods
agent(value : Agent)
A chainable setter for agent
Sourceagent
Initialize a new Agent, yield it to the block
Sourceagent=(agent : Agent | Nil)
Sourceclient(value : Client)
A chainable setter for client
Sourceclient
Initialize a new Client, yield it to the block
Sourceclient=(client : Client | Nil)
Sourcecloud(value : Cloud)
A chainable setter for cloud
Sourcecloud
Initialize a new Cloud, yield it to the block
Sourcecloud=(cloud : Cloud | Nil)
Sourcecontainer(value : Container)
A chainable setter for container
Sourcecontainer
Initialize a new Container, yield it to the block
Sourcecontainer=(container : Container | Nil)
Sourcedestination(value : Destination)
A chainable setter for destination
Sourcedestination
Initialize a new Destination, yield it to the block
Sourcedestination=(destination : Destination | Nil)
Sourcedll(value : Dll)
A chainable setter for dll
Sourcedll
Initialize a new Dll, yield it to the block
Sourcedns(value : Dns)
A chainable setter for dns
Sourcedns
Initialize a new Dns, yield it to the block
Sourceecs(value : Ecs)
A chainable setter for ecs
Sourceecs
Initialize a new Ecs, yield it to the block
Sourceerror(value : Error)
A chainable setter for error
Sourceerror
Initialize a new Error, yield it to the block
Sourceerror=(error : Error | Nil)
Sourceevent(value : Event)
A chainable setter for event
Sourceevent
Initialize a new Event, yield it to the block
Sourceevent=(event : Event | Nil)
Sourcefile(value : File)
A chainable setter for file
Sourcefile
Initialize a new File, yield it to the block
Sourcefile=(file : File | Nil)
Sourcegroup(value : Group)
A chainable setter for group
Sourcegroup
Initialize a new Group, yield it to the block
Sourcegroup=(group : Group | Nil)
Sourcehost(value : Host)
A chainable setter for host
Sourcehost
Initialize a new Host, yield it to the block
Sourcehost=(host : Host | Nil)
Sourcehttp(value : Http)
A chainable setter for http
Sourcehttp
Initialize a new Http, yield it to the block
Sourcehttp=(http : Http | Nil)
Sourcelabels(new_value : Hash(String, String))
A chainable setter for labels
Sourcelabels
labels
Custom key/value pairs.
Can be used to add meta information to events. Should not contain nested
objects. All values are stored as keyword.
Example: docker and k8s labels.
Level: Core
Type: Object
Object Type: Keyword
Example:
{"application": "foo-bar", "env": "production"}
Sourcelabels=(labels : Hash(String, String) | Nil)
labels
Custom key/value pairs.
Can be used to add meta information to events. Should not contain nested
objects. All values are stored as keyword.
Example: docker and k8s labels.
Level: Core
Type: Object
Object Type: Keyword
Example:
{"application": "foo-bar", "env": "production"}
Sourcelog(value : Log)
A chainable setter for log
Sourcelog
Initialize a new Log, yield it to the block
Sourcemessage(new_value : String)
A chainable setter for message
Sourcemessage
message
For log events the message field contains the log message, optimized for viewing
in a log viewer.
For structured logs without an original message field, other fields can be
concatenated to form a human-readable summary of the event.
If multiple messages exist, they can be combined into one message.
Level: Core
Type: Text
Example:
Hello World
Sourcemessage=(message : String | Nil)
message
For log events the message field contains the log message, optimized for viewing
in a log viewer.
For structured logs without an original message field, other fields can be
concatenated to form a human-readable summary of the event.
If multiple messages exist, they can be combined into one message.
Level: Core
Type: Text
Example:
Hello World
Sourcenetwork(value : Network)
A chainable setter for network
Sourcenetwork
Initialize a new Network, yield it to the block
Sourcenetwork=(network : Network | Nil)
Sourceobserver(value : Observer)
A chainable setter for observer
Sourceobserver
Initialize a new Observer, yield it to the block
Sourceobserver=(observer : Observer | Nil)
Sourceorganization(value : Organization)
A chainable setter for organization
Sourceorganization
Initialize a new Organization, yield it to the block
Sourceorganization=(organization : Organization | Nil)
Sourcepackage(value : Package)
A chainable setter for package
Sourcepackage
Initialize a new Package, yield it to the block
Sourcepackage=(package : Package | Nil)
Sourceprocess(value : Process)
A chainable setter for process
Sourceprocess
Initialize a new Process, yield it to the block
Sourceprocess=(process : Process | Nil)
Sourceregistry(value : Registry)
A chainable setter for registry
Sourceregistry
Initialize a new Registry, yield it to the block
Sourceregistry=(registry : Registry | Nil)
Sourcerule(value : Rule)
A chainable setter for rule
Sourcerule
Initialize a new Rule, yield it to the block
Sourcerule=(rule : Rule | Nil)
Sourceserver(value : Server)
A chainable setter for server
Sourceserver
Initialize a new Server, yield it to the block
Sourceserver=(server : Server | Nil)
Sourceservice(value : Service)
A chainable setter for service
Sourceservice
Initialize a new Service, yield it to the block
Sourceservice=(service : Service | Nil)
Sourcesource(value : Source)
A chainable setter for source
Sourcesource
Initialize a new Source, yield it to the block
Sourcesource=(source : Source | Nil)
Sourcethreat(value : Threat)
A chainable setter for threat
Sourcethreat
Initialize a new Threat, yield it to the block
Sourcethreat=(threat : Threat | Nil)
Sourcetimestamp(new_value : Time)
A chainable setter for timestamp
Sourcetimestamp
@timestamp
Date/time when the event originated.
This is the date/time extracted from the event, typically representing when the
event was generated by the source.
If the event source has no original timestamp, this value is typically populated
by the first time the event was received by the pipeline.
Required field for all events.
Level: Core
Type: Date
Example:
2016-05-23T08:05:34.853Z
Sourcetimestamp=(timestamp : Time | Nil)
@timestamp
Date/time when the event originated.
This is the date/time extracted from the event, typically representing when the
event was generated by the source.
If the event source has no original timestamp, this value is typically populated
by the first time the event was received by the pipeline.
Required field for all events.
Level: Core
Type: Date
Example:
2016-05-23T08:05:34.853Z
Sourcetls(value : Tls)
A chainable setter for tls
Sourcetls
Initialize a new Tls, yield it to the block
Sourcetrace(value : Trace)
A chainable setter for trace
Sourcetrace
Initialize a new Trace, yield it to the block
Sourcetrace=(trace : Trace | Nil)
Sourcetransaction(value : Transaction)
A chainable setter for transaction
Sourcetransaction
Initialize a new Transaction, yield it to the block
Sourcetransaction=(transaction : Transaction | Nil)
Sourceurl(value : Url)
A chainable setter for url
Sourceurl
Initialize a new Url, yield it to the block
Sourceuser(value : User)
A chainable setter for user
Sourceuser
Initialize a new User, yield it to the block
Sourceuser=(user : User | Nil)
Sourceuseragent(value : UserAgent)
A chainable setter for useragent
Sourceuseragent
Initialize a new UserAgent, yield it to the block
Sourceuseragent=(useragent : UserAgent | Nil)
Sourcevulnerability(value : Vulnerability)
A chainable setter for vulnerability
Sourcevulnerability
Initialize a new Vulnerability, yield it to the block
Sourcevulnerability=(vulnerability : Vulnerability | Nil)
Source