Reporting Overview

Anything you do in Sym is gathered and expressed in a centralized audit stream. Handy!

Overview

One of the primary benefits of Sym's platform is our powerful built-in auditing capabilities. Historically, engineering teams have suffered from last-minute requests for logs and reports that require complex SQL queries and haphazard log statements. Sym's Templates codify the semantic intent of your security workflow, so we know exactly what you'd want to be logged and recorded.

Whether you're piping logs into your monitoring tool of choice or preparing for your next annual audit, Sym's reporting tools are a good friend to have in your corner.

Simply define a Log Destination, such as AWS Kinesis, and add it to your Flow's Environment. A sample of the JSON streamed to you for Flow's using the sym:approval Template is below, and the full schema can be found here.

Sample Logs

πŸ“˜

The id field is guaranteed to be consistent across duplicate LogEntry records.

{
    "id": "f1e0b0fe-a1cd-46f2-9772-7ded922d26d1",
    "meta": {
        "schema_version": 4
    },
    "state": {
        "status": "completed",
        "errors": []
    },
    "run": {
        "srn": "healthy-health:run:approval-flow-sandbox:4.0.0:4e41814e-34b2-418c-9582-2d8bc610ea2a",
        "parent": "healthy-health:run:flow_selection:1.0.0:0e6dda1c-f6ad-47ac-9e51-b068dd6f901d",
        "flow": "healthy-health:flow:approval-flow-sandbox:4.0.0",
        "actors":  {
            "prompt": {
               "user": "healthy-health:user:4f36af92-f3a6-4476-b7d4-f7ee82efe088:latest",
               "name": "Ben Bitdiddle",
               "username": "[email protected]",
               "identity": {
                   "service": "slack",
                   "external_id": "TABC123",
                   "user_id": "UABC123"
                }
            }
        }
    },
    "event": {
        "srn": "sym:event-spec:approval:1.0.0:request",
        "type": "request",
        "template": "sym:template:approval:1.0.0",
        "timestamp": "2022-02-15T15:43:45.309236+00:00",
        "channel": "slack"
    },
    "actor": {
        "user": "healthy-health:user:4f36af92-f3a6-4476-b7d4-f7ee82efe088:latest",
        "name": "Ben Bitdiddle",
        "username": "[email protected]",
        "identity": {
            "service": "slack",
            "external_id": "TABC123",
            "user_id": "UABC123"
        }
    },
    "fields": {
        "reason": "foobar",
        "duration": 30,
        "target": {
            "name": "test-target",
            "srn": "healthy-health:target:sandbox-leslielam:latest:request",
            "type": "aws_iam_group",
            "label": "Test Target",
            "settings": {
                "iam_group": "prod-break-glass"
            }
        },
        "urgency": "low",
        "target_id": "1c621be7-8531-4200-a0d3-841e1c88e28b"
    },
    "type": "event"
}