It is a C# client library that helps implementing application instrumentation. Basically it helps you sending structured events regarding what happens in your application to some server to analyze them later.
Basically library consists of 3 parts:
- Config file format. JSON-based format, easily edited by guys from BI (Business Intelligence) team.
- .NET library that helps with composing events
- Codegen tool to generate code in C# to provide you some necessary boilerplate
To start using the library you should:
- Compose your config with events you'd like to send. Here is an example relevant for a mobile application
"ambient_context": {
"user_id": "#string",
"session_id": "#string",
"login_mode": "#string",
"app_version": "#string",
"os_name": "#string",
"os_version": "#string",
"timestamp": "$long",
},
"groups": [
{
"percent": 30,
"fields": {
"event_group": "CLIENT_INSTRUMENTATION",
"user_id": "@user_id",
"session_id": "@session_id",
"login_mode": "@login_mode",
"app_version": "@app_version",
"os_name": "@os_name",
"os_version": "@os_version"
},
"groups": [
{
"fields": {
"event_sub_group": "AUTH"
},
"events": [
{
"id": "LOGGED_IN",
"fields": {
"event_type": "LOGGED_IN",
"login_type": "$string"
}
}
]
}
]
}
]
}
-
Invoke
EventStream.Codegen.exe -i path_to_config.json -o GeneratedEvents.cs -c GeneratedEvents -n MyAppNamespace -
Add generated .cs file to your project
-
Add similar code to app startup logic
var config = new ConfigParser(File.OpenRead("config.json")).ReadFullConfig();
var context = new AmbientContext();
var eventStreaming = new EventStreaming.EventStream(
context,
new BufferingEventDispatcher(new ConsoleEventSender()),
new EventStreamSettings(),
config);
context.SetAppVersion("1.01");
context.SetOsName("Windows");
context.SetUserId("123"); // This code can be added later
context.SetSessionId("1234"); // This code can be added later
context.SetTimestampFunc(() => DateTime.Now.Millisecond);
- And finally
eventStreaming.SendAsync(GeneratedEvents.LOGGED_IN("Facebook"));