jjti / go-spancheck / 8774858184

85%

Build Type

push

github

Committed by web-flow

Commit Message

Add support for "Start" utility methods (#16)

* feat: replace hardcoded span start function names with regex patterns

Replaces the hardcoded list of function names and packages with a list
of regex patterns that may be extended using the
`-extra-start-span-signatures` command line option.

The format is `<regex>:<telemetry-type>`. Ideally this would just be a
list of regex patterns, but we need to know what telemetry library we're
matching so we don't run RecordError on opencensus.

* tests: update tests to use new default config

The tests need to unconditionally include the
DefaultStartSpanSignatures, which was not possible with the old harness.

Instead of returning an object directly, they now return a function to
prepare a config, which ensures they all start out with the default
config as a base.

* Add test, skip validating spans within starter funcs

* Hack: fix check for start func method name

* fix: increase robustness of skipping custom matchers

Instead of checking if the function name matches, which might result in
overzealous exclusions, prefer to match against the function signature
itself

* docs: document new behaviour

* Remove sig split in config

* nit: small wording changes

---------

Co-authored-by: josh <joshua.timmons1@gmail.com>

Run Details

62 of 82 new or added lines in 2 files covered. (75.61%)

3 existing lines in 1 file now uncovered.

345 of 411 relevant lines covered (83.94%)

1.0 hits per line