| 1 |
version: "2" |
| 2 |
run: |
| 3 |
issues-exit-code: 1 |
| 4 |
tests: true |
| 5 |
linters: |
| 6 |
default: none |
| 7 |
enable: |
| 8 |
- asasalint |
| 9 |
- bodyclose |
| 10 |
- depguard |
| 11 |
- errcheck |
| 12 |
- errorlint |
| 13 |
- gocritic |
| 14 |
- godot |
| 15 |
- gosec |
| 16 |
- govet |
| 17 |
- ineffassign |
| 18 |
- misspell |
| 19 |
- modernize |
| 20 |
- noctx |
| 21 |
- perfsprint |
| 22 |
- revive |
| 23 |
- staticcheck |
| 24 |
- testifylint |
| 25 |
- unconvert |
| 26 |
- unparam |
| 27 |
- unused |
| 28 |
- usestdlibvars |
| 29 |
- usetesting |
| 30 |
settings: |
| 31 |
depguard: |
| 32 |
rules: |
| 33 |
auto/sdk: |
| 34 |
files: |
| 35 |
- '!internal/global/trace.go' |
| 36 |
- ~internal/global/trace_test.go |
| 37 |
deny: |
| 38 |
- pkg: go.opentelemetry.io/auto/sdk |
| 39 |
desc: Do not use SDK from automatic instrumentation. |
| 40 |
non-tests: |
| 41 |
files: |
| 42 |
- '!$test' |
| 43 |
- '!**/*test/*.go' |
| 44 |
- '!**/internal/matchers/*.go' |
| 45 |
deny: |
| 46 |
- pkg: testing |
| 47 |
- pkg: github.com/stretchr/testify |
| 48 |
- pkg: crypto/md5 |
| 49 |
- pkg: crypto/sha1 |
| 50 |
- pkg: crypto/**/pkix |
| 51 |
otel-internal: |
| 52 |
files: |
| 53 |
- '**/sdk/*.go' |
| 54 |
- '**/sdk/**/*.go' |
| 55 |
- '**/exporters/*.go' |
| 56 |
- '**/exporters/**/*.go' |
| 57 |
- '**/schema/*.go' |
| 58 |
- '**/schema/**/*.go' |
| 59 |
- '**/metric/*.go' |
| 60 |
- '**/metric/**/*.go' |
| 61 |
- '**/bridge/*.go' |
| 62 |
- '**/bridge/**/*.go' |
| 63 |
- '**/trace/*.go' |
| 64 |
- '**/trace/**/*.go' |
| 65 |
- '**/log/*.go' |
| 66 |
- '**/log/**/*.go' |
| 67 |
deny: |
| 68 |
- pkg: go.opentelemetry.io/otel/internal$ |
| 69 |
desc: Do not use cross-module internal packages. |
| 70 |
- pkg: go.opentelemetry.io/otel/internal/internaltest |
| 71 |
desc: Do not use cross-module internal packages. |
| 72 |
otlp-internal: |
| 73 |
files: |
| 74 |
- '!**/exporters/otlp/internal/**/*.go' |
| 75 |
deny: |
| 76 |
- pkg: go.opentelemetry.io/otel/exporters/otlp/internal |
| 77 |
desc: Do not use cross-module internal packages. |
| 78 |
otlpmetric-internal: |
| 79 |
files: |
| 80 |
- '!**/exporters/otlp/otlpmetric/internal/*.go' |
| 81 |
- '!**/exporters/otlp/otlpmetric/internal/**/*.go' |
| 82 |
deny: |
| 83 |
- pkg: go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal |
| 84 |
desc: Do not use cross-module internal packages. |
| 85 |
otlptrace-internal: |
| 86 |
files: |
| 87 |
- '!**/exporters/otlp/otlptrace/*.go' |
| 88 |
- '!**/exporters/otlp/otlptrace/internal/**.go' |
| 89 |
deny: |
| 90 |
- pkg: go.opentelemetry.io/otel/exporters/otlp/otlptrace/internal |
| 91 |
desc: Do not use cross-module internal packages. |
| 92 |
semconv: |
| 93 |
list-mode: lax |
| 94 |
files: |
| 95 |
- "!**/semconv/**" |
| 96 |
- "!**/exporters/zipkin/**" |
| 97 |
deny: |
| 98 |
- pkg: go.opentelemetry.io/otel/semconv |
| 99 |
desc: "Use go.opentelemetry.io/otel/semconv/v1.40.0 instead. If a newer semconv version has been released, update the depguard rule." |
| 100 |
allow: |
| 101 |
- go.opentelemetry.io/otel/semconv/v1.40.0 |
| 102 |
gocritic: |
| 103 |
disabled-checks: |
| 104 |
- appendAssign |
| 105 |
- commentedOutCode |
| 106 |
- dupArg |
| 107 |
- hugeParam |
| 108 |
- importShadow |
| 109 |
- preferDecodeRune |
| 110 |
- rangeValCopy |
| 111 |
- unnamedResult |
| 112 |
- whyNoLint |
| 113 |
enable-all: true |
| 114 |
godot: |
| 115 |
exclude: |
| 116 |
# Exclude links. |
| 117 |
- '^ *\[[^]]+\]:' |
| 118 |
# Exclude sentence fragments for lists. |
| 119 |
- ^[ ]*[-•] |
| 120 |
# Exclude sentences prefixing a list. |
| 121 |
- :$ |
| 122 |
misspell: |
| 123 |
locale: US |
| 124 |
ignore-rules: |
| 125 |
- cancelled |
| 126 |
modernize: |
| 127 |
disable: |
| 128 |
- omitzero |
| 129 |
perfsprint: |
| 130 |
int-conversion: true |
| 131 |
err-error: true |
| 132 |
errorf: true |
| 133 |
sprintf1: true |
| 134 |
strconcat: true |
| 135 |
revive: |
| 136 |
confidence: 0.01 |
| 137 |
rules: |
| 138 |
- name: blank-imports |
| 139 |
- name: bool-literal-in-expr |
| 140 |
- name: constant-logical-expr |
| 141 |
- name: context-as-argument |
| 142 |
arguments: |
| 143 |
- allowTypesBefore: '*testing.T' |
| 144 |
disabled: true |
| 145 |
- name: context-keys-type |
| 146 |
- name: deep-exit |
| 147 |
- name: defer |
| 148 |
arguments: |
| 149 |
- - call-chain |
| 150 |
- loop |
| 151 |
- name: dot-imports |
| 152 |
- name: duplicated-imports |
| 153 |
- name: early-return |
| 154 |
arguments: |
| 155 |
- preserveScope |
| 156 |
- name: empty-block |
| 157 |
- name: empty-lines |
| 158 |
- name: error-naming |
| 159 |
- name: error-return |
| 160 |
- name: error-strings |
| 161 |
- name: errorf |
| 162 |
- name: exported |
| 163 |
arguments: |
| 164 |
- sayRepetitiveInsteadOfStutters |
| 165 |
- name: flag-parameter |
| 166 |
- name: identical-branches |
| 167 |
- name: if-return |
| 168 |
- name: import-shadowing |
| 169 |
- name: increment-decrement |
| 170 |
- name: indent-error-flow |
| 171 |
arguments: |
| 172 |
- preserveScope |
| 173 |
- name: package-comments |
| 174 |
- name: range |
| 175 |
- name: range-val-in-closure |
| 176 |
- name: range-val-address |
| 177 |
- name: redefines-builtin-id |
| 178 |
- name: string-format |
| 179 |
arguments: |
| 180 |
- - panic |
| 181 |
- /^[^\n]*$/ |
| 182 |
- must not contain line breaks |
| 183 |
- name: struct-tag |
| 184 |
- name: superfluous-else |
| 185 |
arguments: |
| 186 |
- preserveScope |
| 187 |
- name: time-equal |
| 188 |
- name: unconditional-recursion |
| 189 |
- name: unexported-return |
| 190 |
- name: unhandled-error |
| 191 |
arguments: |
| 192 |
- fmt.Fprint |
| 193 |
- fmt.Fprintf |
| 194 |
- fmt.Fprintln |
| 195 |
- fmt.Print |
| 196 |
- fmt.Printf |
| 197 |
- fmt.Println |
| 198 |
- name: unused-parameter |
| 199 |
- name: unused-receiver |
| 200 |
- name: unnecessary-stmt |
| 201 |
- name: use-any |
| 202 |
- name: useless-break |
| 203 |
- name: var-declaration |
| 204 |
- name: var-naming |
| 205 |
arguments: |
| 206 |
- ["ID"] # AllowList |
| 207 |
- ["Otel", "Aws", "Gcp"] # DenyList |
| 208 |
- - skip-package-name-collision-with-go-std: true |
| 209 |
- name: waitgroup-by-value |
| 210 |
testifylint: |
| 211 |
enable-all: true |
| 212 |
disable: |
| 213 |
- float-compare |
| 214 |
- go-require |
| 215 |
- require-error |
| 216 |
usetesting: |
| 217 |
context-background: true |
| 218 |
context-todo: true |
| 219 |
exclusions: |
| 220 |
generated: lax |
| 221 |
presets: |
| 222 |
- common-false-positives |
| 223 |
- legacy |
| 224 |
- std-error-handling |
| 225 |
rules: |
| 226 |
- linters: |
| 227 |
- revive |
| 228 |
path: schema/v.*/types/.* |
| 229 |
text: avoid meaningless package names |
| 230 |
# TODO: Having appropriate comments for exported objects helps development, |
| 231 |
# even for objects in internal packages. Appropriate comments for all |
| 232 |
# exported objects should be added and this exclusion removed. |
| 233 |
- linters: |
| 234 |
- revive |
| 235 |
path: .*internal/.* |
| 236 |
text: exported (method|function|type|const) (.+) should have comment or be unexported |
| 237 |
# Yes, they are, but it's okay in a test. |
| 238 |
- linters: |
| 239 |
- revive |
| 240 |
path: _test\.go |
| 241 |
text: exported func.*returns unexported type.*which can be annoying to use |
| 242 |
# Example test functions should be treated like main. |
| 243 |
- linters: |
| 244 |
- revive |
| 245 |
path: example.*_test\.go |
| 246 |
text: calls to (.+) only in main[(][)] or init[(][)] functions |
| 247 |
# It's okay to not run gosec and perfsprint in a test. |
| 248 |
- linters: |
| 249 |
- gosec |
| 250 |
- perfsprint |
| 251 |
path: _test\.go |
| 252 |
# Ignoring gosec G404: Use of weak random number generator (math/rand instead of crypto/rand) |
| 253 |
# as we commonly use it in tests and examples. |
| 254 |
- linters: |
| 255 |
- gosec |
| 256 |
text: 'G404:' |
| 257 |
# Ignoring gosec G402: TLS MinVersion too low |
| 258 |
# as the https://pkg.go.dev/crypto/tls#Config handles MinVersion default well. |
| 259 |
- linters: |
| 260 |
- gosec |
| 261 |
text: 'G402: TLS MinVersion too low.' |
| 262 |
issues: |
| 263 |
max-issues-per-linter: 0 |
| 264 |
max-same-issues: 0 |
| 265 |
formatters: |
| 266 |
enable: |
| 267 |
- gofumpt |
| 268 |
- goimports |
| 269 |
- golines |
| 270 |
settings: |
| 271 |
gofumpt: |
| 272 |
extra-rules: true |
| 273 |
goimports: |
| 274 |
local-prefixes: |
| 275 |
- go.opentelemetry.io/otel |
| 276 |
golines: |
| 277 |
max-len: 120 |
| 278 |
exclusions: |
| 279 |
generated: lax |