Documentation
¶
Overview ¶
Package fields is intended to be the SSOT for Go applications for all of the field names used within our observability setup.
This is intended to help enforce consistency across components when it comes to field names.
Labkit-Ruby: https://gitlab.com/gitlab-org/ruby/gems/labkit-ruby/-/blob/master/lib/labkit/fields.rb?ref_type=heads
For Engineers Looking to add fields:
Please see the handbook page for more information https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/observability_field_standardisation/
Note: this Go package sets the standards for all Labkit variants. Other Labkit variants will be derived from the fields defined within this package to ensure consistency.
Index ¶
Constants ¶
const ( // correlation_id - string // This field is used to correlate // the logs emitted by all of our systems. // This should be present in all log line // emissions. CorrelationID = "correlation_id" // GitLabUserID - an integer field that // captures the user's numeric ID for logging purposes. GitLabUserID = "gl_user_id" // GitLabUserName - a string field that // captures the user's username for logging purposes. GitLabUserName = "gl_user_name" // ErrorType - a string field that should contain the error type or classification // (e.g., "NoMethodError", "ValidationError"). ErrorType = "error_type" // ErrorMessage - a string field that should contain the detailed error message // (e.g., "undefined method `boom!' for nil"). ErrorMessage = "error_message" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files