README
¶
Starlark Common Plugin
This plugin provides Starlark to Neptunus plugins.
Builtin types
This plugin defines new type - event - as Neptunus event representation in starlark code with methods referenced to Event API:
getId() (id String)- get event idsetId(key String)- set event idgetRK() (key String)- get event routing keysetRK(key String)- set event routing keygetTimestamp() (t Time)- get event timestampsetTimestamp(t Time)- set event timestampsetLabel(key String, value String)- add/overwrite event labelgetLabel(key String) (value String|None)- get label value by key; if label does not exist, None returnsdelLabel(key String)- delete label by keygetField(path String) (value String|Bool|Number|Float|Dict|List|Time|Duration|None)- get field value by path; see type conversionssetField(path String, value String|Bool|Number|Float|Dict|List|Time|Duration) (error Error|None)- set field value by path; see type conversionsdelField(path String)- delete field by pathaddTag(tag String)- add tag to eventdelTag(tag String)- delete tag from eventhasTag(tag String) (ok Bool)- check if event has tag
Also, you can create a new event using newEvent(key String) (event Event) builtin function.
The other new type - error - represents Golang error type. New error may be created through error(text String) (error Error) function. Processing of this type depends on plugins.
Type conversions
- Golang string <-> Starlark String
- Golang int -> Starlark Int -> Golang int64
- Golang uint -> Starlark Int -> Golang uint64
- Golang bool <-> Starlark Bool
- Golang float -> Starlark Float -> Gloang float64
- Golang array or slice -> Starlark List -> Gloang slice
- Golang map[string]T <-> Starlark Dict
- Golang time.Time <-> starlark Time
- Golang time.Duration <-> starlark Duration
[!WARNING]
Remember that any event method returns a value, not a reference. So if you need to update data, you need to do it directly.
# bad
def process(event):
dictField = event.getField("path.to.field")
dictField["key"] = "new data"
return event
# good
def process(event):
dictField = event.getField("path.to.field")
dictField["key"] = "new data"
event.setField("path.to.field", dictField)
return event
Starlark modules
[!WARNING]
Modules import is allowed in any script, but import loop checks are not performed.
Embedded
Three embedded modules are supported:
- time - provides time-related constants and functions
- math - provides basic constants and mathematical functions
- json - utilities for converting Starlark values to/from JSON strings
For import, call the load() function, after which a module functions and variables will become available for use via module struct:
load("math.star", "math")
load("time.star", "time")
load("json.star", "json")
print(time.now())
Custom
Import of custom modules is also supported. A user module is just a script with predefined functions and variables, but for better experience it is recommended to combine them into one struct:
# myModule.star
helloMessage = "hello from module"
def hello():
print(helloMessage)
myModule = struct(
hello = hello
helloMessage = helloMessage
)
Then use of the module will not differ from the built-in ones:
# process.star
load("myModule.star", "myModule")
myModule.hello() # prints "hello from module"
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Source Files