diff --git a/fields/doc.go b/fields/doc.go index 505b2b7154963bc62228f3b423fea02cb297d874..e4435b9bed0a376d066fc696f67f2b5c05992f39 100644 --- a/fields/doc.go +++ b/fields/doc.go @@ -4,5 +4,17 @@ 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. */ package fields diff --git a/fields/fields.go b/fields/fields.go index 930a4ee88d5a689a6cdff0f23d8a5c64632007a0..beb605c6f5025a2851c1f7153a0dc5989d3dcf0a 100644 --- a/fields/fields.go +++ b/fields/fields.go @@ -15,4 +15,10 @@ const ( // GitLabUserName - a string field that // captures the user's username for logging purposes. GitLabUserName = "gl_user_name" + + // New fields being added to this section should have + // the appropriate doc comments added above. These + // should clearly indicate what the intended use of the + // field is and should be replicated across the labkit + // variations. )