Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
479 changes: 479 additions & 0 deletions javascript/sentry-conventions/src/attributes.ts

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"key": "grpc.error.bad_request.field_violations",
"brief": "The individual field violations from a google.rpc.BadRequest error detail. Each entry is a JSON-encoded object with field, description, reason, and (optional) localized_message keys, mirroring google.rpc.BadRequest.FieldViolation.",
"type": "string[]",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": false,
"visibility": "public",
"example": [
"{\"field\":\"email\",\"description\":\"must be a valid email address\",\"reason\":\"FIELD_INVALID\",\"localized_message\":{\"locale\":\"en-US\",\"message\":\"Must be a valid email address\"}}"
],
"changelog": [
{
Comment thread
sentry[bot] marked this conversation as resolved.
"version": "next",
"prs": [460],
"description": "Added grpc.error.bad_request.field_violations attribute"
}
]
}
18 changes: 18 additions & 0 deletions model/attributes/grpc/grpc__error__debug_info__detail.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.debug_info.detail",
"brief": "Additional debugging information, such as a server-side stack trace, from a google.rpc.DebugInfo error detail. SDKs should only send this attribute when sendDefaultPii is enabled or dataCollection is configured accordingly.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"visibility": "public",
"example": "at com.example.Service.method(Service.java:42)",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.debug_info.detail attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.debug_info.stack_entries",
"brief": "The server-side stack trace entries from a google.rpc.DebugInfo error detail. SDKs should only send this attribute when sendDefaultPii is enabled.",
"type": "string[]",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"visibility": "public",
"example": ["com.example.Service.method(Service.java:42)", "com.example.Server.handle(Server.java:100)"],
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.debug_info.stack_entries attribute"
}
]
}
18 changes: 18 additions & 0 deletions model/attributes/grpc/grpc__error__error_info__domain.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.error_info.domain",
"brief": "The logical grouping to which the gRPC error reason belongs, from the google.rpc.ErrorInfo error detail.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": false,
"visibility": "public",
"example": "example.sentry.io",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.error_info.domain attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"key": "grpc.error.error_info.metadata.<key>",
"brief": "Additional structured metadata attached to a google.rpc.ErrorInfo error detail, with <key> being the metadata key name. SDKs should only send this attribute when sendDefaultPii is enabled.",
"has_dynamic_suffix": true,
"type": "string",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"visibility": "public",
"example": "grpc.error.error_info.metadata.user_id='123'",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.error_info.metadata.<key> attribute"
}
]
}
18 changes: 18 additions & 0 deletions model/attributes/grpc/grpc__error__error_info__reason.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.error_info.reason",
"brief": "The reason for the gRPC error, as defined by the service that generated it, from the google.rpc.ErrorInfo error detail.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": false,
"visibility": "public",
"example": "FIELD_INVALID",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.error_info.reason attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"key": "grpc.error.precondition_failure.violations",
"brief": "The individual precondition violations from a google.rpc.PreconditionFailure error detail. Each entry is a JSON-encoded object with type, subject, and description keys. SDKs should only send this attribute when sendDefaultPii is enabled, since violation subjects may identify specific resources or users.",
"type": "string[]",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"visibility": "public",
"example": [
"{\"type\":\"TOS\",\"subject\":\"example.com/user/123\",\"description\":\"User must accept the terms of service\"}"
],
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.precondition_failure.violations attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"key": "grpc.error.quota_failure.violations",
"brief": "The individual quota violations from a google.rpc.QuotaFailure error detail. Each entry is a JSON-encoded object with subject, description, api_service, quota_metric, quota_id, quota_dimensions, quota_value, and (optional) future_quota_value keys, mirroring google.rpc.QuotaFailure.Violation. SDKs should only send this attribute when sendDefaultPii is enabled, since violation subjects may identify specific resources or users.",
"type": "string[]",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"visibility": "public",
"example": [
"{\"subject\":\"clientip:127.0.0.1\",\"description\":\"Limit checks failed.\",\"api_service\":\"example.googleapis.com\",\"quota_metric\":\"example.googleapis.com/read_requests\",\"quota_id\":\"ReadRequestsPerMinutePerProject\",\"quota_dimensions\":{\"region\":\"us-central1\"},\"quota_value\":1000}"
],
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.quota_failure.violations attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.resource_info.description",
"brief": "A description of the error that occurred while accessing the resource, from a google.rpc.ResourceInfo error detail.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": false,
"visibility": "public",
"example": "Instance is not ready for the request.",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.resource_info.description attribute"
}
]
}
18 changes: 18 additions & 0 deletions model/attributes/grpc/grpc__error__resource_info__owner.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.resource_info.owner",
"brief": "The owner of the resource being accessed (e.g. project or account owning it), from a google.rpc.ResourceInfo error detail. SDKs should only send this attribute when sendDefaultPii is enabled.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"visibility": "public",
"example": "user@example.com",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.resource_info.owner attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.resource_info.resource_name",
"brief": "The name of the resource being accessed, from a google.rpc.ResourceInfo error detail. SDKs should only send this attribute when sendDefaultPii is enabled.",
"type": "string",
"apply_scrubbing": {
"key": "auto"
},
"is_in_otel": false,
"visibility": "public",
"example": "projects/example/instances/example-instance",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.resource_info.resource_name attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.resource_info.resource_type",
"brief": "The type of resource being accessed, from a google.rpc.ResourceInfo error detail.",
"type": "string",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": false,
"visibility": "public",
"example": "database",
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.resource_info.resource_type attribute"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"key": "grpc.error.retry_info.retry_delay_in_ms",
"brief": "How long the client should wait before retrying the gRPC call, in milliseconds, from the google.rpc.RetryInfo error detail.",
"type": "integer",
"apply_scrubbing": {
"key": "manual"
},
"is_in_otel": false,
"visibility": "public",
"example": 5000,
"changelog": [
{
"version": "next",
"prs": [460],
"description": "Added grpc.error.retry_info.retry_delay_in_ms attribute"
}
]
}
Loading
Loading