Repository navigation
docs: OTLP recipes, search snippet fix, JSDoc, repo root cleanup - #98
Merged
Merged
Conversation
… add OTLP recipes Adds OtlpLogTransport, toOtelSeverity and OtlpLogTransportConfig to the logixia/transports entry, and docs/otlp-recipes.md with Grafana Loki, Grafana Cloud, Axiom, Better Stack and local Collector configs, with the URLs and headers taken from vendor docs (linked per section). Linked from the README OTLP section. Closes #24
…r API Uses logixia/search, maxIndexSize, indexLogs, the (query, filters, options) search signature, naturalLanguageSearch and correlateByTraceId. The snippet is also examples/search-readme.ts; it was run with ts-node and against dist. Closes #25
Comment-only change: class overview with example, logging methods, timers, level/context/field management, transport levels, child, flush, healthCheck, close and createLogger (including how custom levels become methods). Closes #26
Removed (nothing referenced them in package.json, workflows, configs, docs site or README links): - IMPLEMENTATION_SUMMARY.md: one-off search implementation note, only referenced by the SEARCH_* docs it described - git-commands.sh: personal staging script naming files that do not exist - test/analyze.test.ts: copy of src/cli/__tests__/analyze.test.ts that never runs (jest roots is src) Moved into docs/ with internal links fixed: SEARCH_DOCUMENTATION.md, SEARCH_FEATURE.md, SEARCH_QUICK_REFERENCE.md, CUSTOMIZATION.md. Kept: test/fixtures/shutdown-app.ts (used by shutdown.process.test.ts) and todo/, todos/, research/ (left for the maintainer to decide). Closes #36
uuid is no longer imported anywhere in src, tests, examples or benchmarks (@types/uuid was already gone). Refs #86
…interceptors The WebSocket and Kafka trace interceptors declared config as a constructor parameter property and then reassigned it, so the parameter write was dead (CodeQL js/useless-assignment-to-property). Declare it as a field instead; behaviour is unchanged. Refs #86
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned Files
|
setLevel() wrote the cached threshold directly, so a later cache rebuild (enableField, setNamespaceLevels, patchNamespaceLevels) recomputed it from the ENV or namespace level and silently reverted the override while getLevel() still reported the new level. The override is now stored and resolveEffectiveLevel() honours it first, ahead of LOGIXIA_LEVEL_<NS>, namespaceLevels and LOGIXIA_LEVEL. Adds a regression test. Also corrects the JSDoc added earlier: createLogger example uses levels that actually log, and logLevel, getLevel, setLevel and close describe the real behaviour (close points to the gracefulShutdown option).
…do entry - docs/index.html: replace the non-existent LogSearcher snippet with the SearchManager API from logixia/search - src/search.ts: module JSDoc uses indexLogs and the (query, filters, options) search signature - package.json: add dev:search-readme for examples/search-readme.ts - todo/03-testing.md: remove the deleted test/analyze.test.ts row
9 tasks
# Conflicts: # package.json
|
🎉 This issue has been resolved in version 2.0.1. |
8 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docs and cleanup: OTLP recipes, a corrected README search snippet, JSDoc, a repo-root cleanup, and the leftovers from #86.
Closes #24, closes #25, closes #26, closes #36. Refs #86.
Changes
OtlpLogTransport,toOtelSeverityandOtlpLogTransportConfigare exported fromlogixia/transports.docs/otlp-recipes.mdcovers a local Collector, Grafana Loki / Grafana Cloud, Axiom and Better Stack, each linking the vendor doc it is based on.logixia/searchAPI.examples/search-readme.tsruns it.LogixiaLoggermethod and oncreateLogger. Comments only.IMPLEMENTATION_SUMMARY.md,git-commands.sh, and the deadtest/analyze.test.ts, which jest never ran.docs/, with links fixed:SEARCH_*.mdandCUSTOMIZATION.md.test/fixtures/shutdown-app.ts, which a test uses.todo/,todos/andresearch/, pending a maintainer decision.uuiddevDependency is removed.configproperty in the Kafka and WebSocket trace interceptors).CodeQL alerts to dismiss after merge
file-access-to-httpinbatch-buffer.ts: the URL comes from developer-supplied transport config.use-before-declarationinsrc/index.ts: a hoisted export.examples/only (unused variables, andMath.randomused for demo data).Test plan
npm pack --dry-runlooks right.