User Events List¶
List user event information matching search criteria.
Usage¶
s10k user events
[-EDq]
[-F=<searchFilter>]
[-t=tag[,tag...]]...
-min=<minDate> -max=<maxDate> [-tz=<zone>]
[-c=columReference[,columReference...]]...
[-x=columExpression[,columExpression...]]...
[-M=max] [-O=<resultOffset>]
[-mode=<displayMode>]
Options¶
Column references¶
The --column option lets you extract specific values out of the event data into columns in PRETTY and CSV display modes.
When this option is given, then by default the Data column is not shown. You can force the data column to be included still
by providing the --show-data option.
Each column reference value has a name:path syntax, where name is the desired column name and
path is a URL path-like reference to the data value to extract. The leading / of the path is
optional. The name can include a > suffix to make the values right-aligned in PRETTY mode.
For example, imagine this event generated when a Cloud Integration Rake Task began execution:
Example user event
{
"userId" : 123,
"eventId" : "019fcb57-0000-0000-0000-6af8743af668",
"created" : "2026-08-04 05:55:53.123689Z",
"tags" : [ "c2c", "ds", "rake" ],
"message" : "Rake for datum",
"data" : {
"subId" : 345,
"configId" : 234,
"executeAt" : "2026-08-04 04:00:00Z",
"startedAt" : "2026-08-04 05:55:53.119971523Z",
"dateOffset" : "P14D"
}
}
If you were interested in the configId, dateOffset, and executeAt data values, you could extract them into columns
with options like:
s10k user events list ... \
--column 'Config ID>:configId' \
--column 'Offset>:dateOffset' \
--column 'Rake Date:executeAt'
+----------------------------------+----------------------+------------------+-----------+--------+----------------------+
| Event Date | Tags | Message | Config ID | Offset | Rake Date |
+----------------------------------+----------------------+------------------+-----------+--------+----------------------+
| 2026-08-04 17:55:53.123689+12:00 | c2c,ds,rake | Rake for datum | 234 | P14D | 2026-08-04 04:00:00Z |
+----------------------------------+----------------------+------------------+-----------+--------+----------------------+
Tip
Note how the Config ID and Offset columns are right-aligned, because of the > suffix added to those
column names in the --column options.
Event Date,Tags,Message,Config ID,Offset,Rake Date
2026-08-04 17:55:53.123689+12:00,"c2c,ds,rake",Rake for datum,234,P14D,2026-08-04 04:00:00Z
Expression columns¶
The --expression option can be used to extract specific values out of events into columns in
PRETTY and CSV output modes, using SpEL expressions. The event itself is used for the
expression root object, meaning you can access any of the properties available on the event.
Take this OCPP inbound message event as an example:
Example OCPP inbound message event
{
"userId" : 123,
"eventId" : "019fc630-0000-0000-0000-7b27c85a07cc",
"created" : "2026-08-03 05:55:01.991793Z",
"tags" : [ "ocpp", "message", "received" ],
"data" : {
"cp" : "chgr03",
"action" : "MeterValues",
"message" : {
"meterValue" : [ {
"timestamp" : "2026-08-03T05:54:59.000Z",
"sampledValue" : [ {
"unit" : "W",
"value" : "0",
"location" : "Outlet",
"measurand" : "Power.Active.Import"
}, {
"unit" : "Percent",
"value" : "60",
"location" : "EV",
"measurand" : "SoC"
} ]
} ],
"connectorId" : 1,
"transactionId" : 605279
},
"messageId" : "cc5b6ab1-0000-0000-0000-3a378c2de2dd"
}
}
If you were interested in the cp value and the value associated with the SoC measurand, you
could extract them into columns with options like:
s10k user events list ... \
--column 'Charger:cp' \
--column "SoC>:data.action == 'MeterValues'
? data.message.meterValue[0].sampledValue.^[measurand == 'SoC']?.value
: null"
+----------------------------------+-----------------------+---------+---------+-----+
| Event Date | Tags | Message | Charger | SoC |
+----------------------------------+-----------------------+---------+---------+-----+
| 2026-08-03 17:55:01.991793+12:00 | ocpp,message,received | | chgr03 | 60 |
+----------------------------------+-----------------------+---------+---------+-----+
Event Date,Tags,Message,Charger,SoC
2026-08-03 17:55:01.991793+12:00,"ocpp,message,received",,chgr03,60
Search filters¶
The --search-filter option allows you to filter the events based on values in the data. It uses
the SolarNetwork Metadata Filter syntax, without the path wildcard support. The key
paths apply to the event data object. Typically you would use the --tag option to narrow the event
category to a specific type of event and then add a --search-filter to narrow the results further
based on the event data.
Take the following example OCPP event:
Example OCPP StartTransaction event
{
"userId" : 123,
"eventId" : "019fc630-0000-0000-0000-ae6160846d7d",
"created" : "2026-08-03 05:55:07.652136Z",
"tags" : [ "ocpp", "message", "received" ],
"data" : {
"cp" : "chgr7",
"action" : "StartTransaction",
"message" : {
"idTag" : "tag01",
"timestamp" : "2026-08-03T05:55:06.000Z",
"meterStart" : 155668770,
"connectorId" : 1
},
"messageId" : "50368fe0-0000-0000-0000-e4616c7a18c9"
}
}
Here are some example search filters to match against that style of event:
| Search filter | Matches | Description |
|---|---|---|
(cp=chgr7) |
Yes | Simple equality match on the cp property. |
(cp~=^chgr) |
Yes | Regular expression match on the cp property for any value starting with chgr. |
(&(cp=chgr7)(action=StartTransaction)) |
Yes | Logical AND match on both the cp and action properties. |
(message/idTag=tag01) |
Yes | Simple equality match in the message/idTag property. |
(message/connectorId>1) |
No | Matches only when message/connectorId is greater than 1. |
(&(cp=chgr7)(!(message/idTag~=^tag))) |
No | Matches only when cp is chgr7 and message/idTag does not start with tag. |
Output¶
A listing of matching events. Each record contains the following properties:
| Property | Description |
|---|---|
| User ID | The account owner ID. Not shown in tabular output modes. |
| Event ID | The event ID. Not shown in tabular output modes unless the --show-event-id option is given. |
| Event Date | The date the event was created. |
| Tags | A list of tags that categorize the event. In JSON output mode this is the created property. |
| Message | The display message. |
| Data | The map-like event data. Not shown in tabular output modes when --column options are given, unless the --show-data option is also given. |
Examples¶
Show events for OCPP StartTransaction messages with chargers whose identity starts with chgr:
s10k user events list --min-date 2026-08-03 --max-date 2026-08-04 \
--tag ocpp,message,received \
--search-filter '(&(cp~=^chgr)(action=StartTransaction))'
+----------------------------------+-----------------------+---------+----------------------------------------------------------------------------+
| Event Date | Tags | Message | Data |
+----------------------------------+-----------------------+---------+----------------------------------------------------------------------------+
| 2026-08-03 17:55:07.652136+12:00 | ocpp,message,received | | cp chgr7 |
| | | | action StartTransaction |
| | | | message {idTag=tag01, timestamp=2026-08-03T05:55:06.000Z, |
| | | | meterStart=155668770, connectorId=1} |
| | | | messageId 50368fe0-0000-0000-0000-e4616c7a18c9 |
| | | | |
+----------------------------------+-----------------------+---------+----------------------------------------------------------------------------+
| 2026-08-03 18:03:13.980869+12:00 | ocpp,message,received | | cp chgr10 |
| | | | action StartTransaction |
| | | | message {idTag=tag01, timestamp=2026-08-03T06:03:11.000Z, |
| | | | meterStart=215457160, connectorId=2} |
| | | | messageId ed0336b7-0000-0000-0000-9cb4de91ed4b |
| | | | |
+----------------------------------+-----------------------+---------+----------------------------------------------------------------------------+
| 2026-08-03 18:04:48.151958+12:00 | ocpp,message,received | | cp chgr10 |
| | | | action StartTransaction |
| | | | message {idTag=tag01, timestamp=2026-08-03T06:04:45.000Z, |
| | | | meterStart=231959680, connectorId=1} |
| | | | messageId eb296cef-0000-0000-0000-376880f68efa |
| | | | |
+----------------------------------+-----------------------+---------+----------------------------------------------------------------------------+
Event Date,Tags,Message,Data
2026-08-03 17:55:07.652136+12:00,"ocpp,message,received",,"cp chgr7
action StartTransaction
message {idTag=tag01, timestamp=2026-08-03T05:55:06.000Z, meterStart=155668770, connectorId=1}
messageId 50368fe0-0000-0000-0000-e4616c7a18c9
"
2026-08-03 18:03:13.980869+12:00,"ocpp,message,received",,"cp chgr10
action StartTransaction
message {idTag=tag01, timestamp=2026-08-03T06:03:11.000Z, meterStart=215457160, connectorId=2}
messageId ed0336b7-0000-0000-0000-9cb4de91ed4b
"
2026-08-03 18:04:48.151958+12:00,"ocpp,message,received",,"cp chgr10
action StartTransaction
message {idTag=tag01, timestamp=2026-08-03T06:04:45.000Z, meterStart=231959680, connectorId=1}
messageId eb296cef-0000-0000-0000-376880f68efa
"
[
{
"userId" : 504,
"eventId" : "019fc630-0000-0000-0000-ae6160846d7d",
"created" : "2026-08-03 05:55:07.652136Z",
"tags" : [ "ocpp", "message", "received" ],
"data" : {
"cp" : "chgr7",
"action" : "StartTransaction",
"message" : {
"idTag" : "tag01",
"timestamp" : "2026-08-03T05:55:06.000Z",
"meterStart" : 155668770,
"connectorId" : 1
},
"messageId" : "50368fe0-0000-0000-0000-e4616c7a18c9"
}
},
{
"userId" : 504,
"eventId" : "019fc638-0000-0000-0000-6171f3c98b17",
"created" : "2026-08-03 06:03:13.980869Z",
"tags" : [ "ocpp", "message", "received" ],
"data" : {
"cp" : "chgr10",
"action" : "StartTransaction",
"message" : {
"idTag" : "tag01",
"timestamp" : "2026-08-03T06:03:11.000Z",
"meterStart" : 215457160,
"connectorId" : 2
},
"messageId" : "ed0336b7-0000-0000-0000-9cb4de91ed4b"
}
},
{
"userId" : 504,
"eventId" : "019fc639-0000-0000-0000-c1b95fae23cb",
"created" : "2026-08-03 06:04:48.151958Z",
"tags" : [ "ocpp", "message", "received" ],
"data" : {
"cp" : "chgr10",
"action" : "StartTransaction",
"message" : {
"idTag" : "tag01",
"timestamp" : "2026-08-03T06:04:45.000Z",
"meterStart" : 231959680,
"connectorId" : 1
},
"messageId" : "eb296cef-0000-0000-0000-376880f68efa"
}
}
]
The same query as before, but this time extract the cp, message/connectorId, message/idTag,
and message/meterStart values into columns:
s10k user events list --min-date 2026-08-03 --max-date 2026-08-04 \
--tag ocpp,message,received \
--search-filter '(&(cp~=^chgr)(action=StartTransaction))' \
--column 'Charger:cp' \
--column 'Connector>:message/connectorId' \
--column 'RFID:message/idTag' \
--column 'Meter>:message/meterStart'
+----------------------------------+-----------------------+---------+---------+-----------+-------+-----------+
| Event Date | Tags | Message | Charger | Connector | RFID | Meter |
+----------------------------------+-----------------------+---------+---------+-----------+-------+-----------+
| 2026-08-03 17:55:07.652136+12:00 | ocpp,message,received | | chgr7 | 1 | tag01 | 155668770 |
+----------------------------------+-----------------------+---------+---------+-----------+-------+-----------+
| 2026-08-03 18:03:13.980869+12:00 | ocpp,message,received | | chgr10 | 2 | tag01 | 215457160 |
+----------------------------------+-----------------------+---------+---------+-----------+-------+-----------+
| 2026-08-03 18:04:48.151958+12:00 | ocpp,message,received | | chgr10 | 1 | tag01 | 231959680 |
+----------------------------------+-----------------------+---------+---------+-----------+-------+-----------+
Event Date,Tags,Message,Charger,Connector,RFID,Meter
2026-08-03 17:55:07.652136+12:00,"ocpp,message,received",,chgr7,1,tag01,155668770
2026-08-03 18:03:13.980869+12:00,"ocpp,message,received",,chgr10,2,tag01,215457160
2026-08-03 18:04:48.151958+12:00,"ocpp,message,received",,chgr10,1,tag01,231959680