Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Event JSON Schema #1394

Open
1 task
ravindk89 opened this issue Jan 14, 2025 · 0 comments
Open
1 task

Add Event JSON Schema #1394

ravindk89 opened this issue Jan 14, 2025 · 0 comments

Comments

@ravindk89
Copy link
Collaborator

Summary

https://min.io/docs/minio/linux/administration/monitoring.html does not currently have an example of an event document.

S3 docs have an example, but we do have some diffs.

https://github.com/minio/minio/blob/master/internal/event/event.go#L64

{
    "eventVersion": "string",
    "eventSource": "string",
    "awsRegion": "string",
    "eventTime": "string",
    "eventName": "string",
    "userIdentity": {
        "principalId": "string"
    },
    "requestParameters": {
        "key": "value"
    },
    "responseElements": {
        "key": "value"
    },
    "s3": {
        "s3SchemaVersion": "string",
        "configurationId": "string",
        "bucket": {
            "name": "string",
            "ownerIdentity": {
                "principalId": "string"
            },
            "arn": "string"
        },
        "object": {
            "key": "string",
            "size": 10000,
            "eTag": "string",
            "contentType": "string",
            "userMetadata": {
                "key": "string"
            },
            "versionId": "string",
            "sequencer": "string"
        }
    },
    "source": {
        "host": "string",
        "port": "string",
        "userAgent": "string"
    }
}

This appears to be our overall schema. Some fields do not always populate, and some fields are general maps where I assume the values may vary (e.g. requestParameter, responseElements)

Goals

  • Add the event schema to the relevant docs page

Non-Goals

Examples of how to use or utilize the returned document

Additional context

this was generated via customer request. Cherry-pick this to AIStor docs later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant