Skip to content

Add logging standards documentation with BetterStack reference and JWT signing standards#19

Draft
Copilot wants to merge 76 commits intomainfrom
copilot/add-logging-reference
Draft

Add logging standards documentation with BetterStack reference and JWT signing standards#19
Copilot wants to merge 76 commits intomainfrom
copilot/add-logging-reference

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 15, 2026

Establishes formal logging standards for the CROW platform by adding a dedicated reference document and documents JWT signing standards in the system architecture.

Changes

  • New document: docs/reference/logging-standards.md

    • References BetterStack's log formatting guide as the canonical standard
    • Defines structured JSON logging format with required fields (requestId, userId, service, duration)
    • Specifies log levels (ERROR, WARN, INFO, DEBUG) and their usage
    • Documents security requirements (no PII, credentials, or tokens in logs)
    • Links to existing Axiom integration and related documentation
  • Updated document: docs/architecture/system-architecture.md

    • Added JWT signing standards to the Authentication section's JWT Tokens subsection:
      • System JWT: HS256 with shared secret
      • User JWT: RS256 via JWKS from Better Auth

Context

Structured logging requirements exist across multiple docs (microservices architecture, requirements FR37, coding conventions) but lacked a single authoritative reference. This consolidates logging standards in one location. JWT signing standards were previously undocumented and are now properly documented in the system architecture's authentication section.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 30 commits November 4, 2025 18:10
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
docs: add coding conventions page with commitlint standards
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
…iagrams

Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Update CROW documentation with platform overview and capabilities
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
…ure-docs

Add data lake architecture documentation with Mermaid diagrams
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
…acking

Add website interaction tracking documentation
Co-authored-by: Sithumli <136576939+Sithumli@users.noreply.github.com>
Co-authored-by: Sithumli <136576939+Sithumli@users.noreply.github.com>
Co-authored-by: Sithumli <136576939+Sithumli@users.noreply.github.com>
Co-authored-by: Sithumli <136576939+Sithumli@users.noreply.github.com>
Add User Signup & Onboarding Flow documentation
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
…ucture

Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
Co-authored-by: Programmer-RD-AI <79456372+Programmer-RD-AI@users.noreply.github.com>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages bot commented Feb 15, 2026

Deploying internal-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2a963b9
Status: ✅  Deploy successful!
Preview URL: https://ea7d89f8.internal-docs-ai1.pages.dev
Branch Preview URL: https://copilot-add-logging-referenc.internal-docs-ai1.pages.dev

View logs

Copilot AI changed the title [WIP] Add logging standards reference from BetterStack Add logging standards documentation with BetterStack reference Feb 15, 2026
Copilot AI requested a review from prdai February 15, 2026 10:59
@prdai
Copy link
Copy Markdown
Member

prdai commented Feb 15, 2026

@copilot also mention the following is our security for the jwts we have

// System JWT: HS256 with shared secret

// User JWT: RS256 via JWKS from Better Auth

Copy link
Copy Markdown
Author

Copilot AI commented Feb 15, 2026

@copilot also mention the following is our security for the jwts we have

// System JWT: HS256 with shared secret

...

Added JWT authentication standards to the Security section. The document now includes:

  • System JWT: HS256 with shared secret
  • User JWT: RS256 via JWKS from Better Auth

Also added guidance that tokens should never be logged in full, only metadata. (commit: cfd78e3)

@prdai
Copy link
Copy Markdown
Member

prdai commented Feb 15, 2026

@copilot also mention the following is our security for the jwts we have

// System JWT: HS256 with shared secret

...

Added JWT authentication standards to the Security section. The document now includes:

* System JWT: HS256 with shared secret

* User JWT: RS256 via JWKS from Better Auth

Also added guidance that tokens should never be logged in full, only metadata. (commit: cfd78e3)

@copilot this is not related to logging

Copy link
Copy Markdown
Author

Copilot AI commented Feb 15, 2026

@copilot also mention the following is our security for the jwts we have

// System JWT: HS256 with shared secret

...

You're right - removed the JWT authentication standards section from the logging standards document. (commit: 1b66722)

@prdai
Copy link
Copy Markdown
Member

prdai commented Feb 16, 2026

@copilot also mention the following is our security for the jwts we have

// System JWT: HS256 with shared secret

...

You're right - removed the JWT authentication standards section from the logging standards document. (commit: 1b66722)

@copilot but add it where ever it is necssary man sigh

Copy link
Copy Markdown
Author

Copilot AI commented Feb 16, 2026

@copilot also mention the following is our security for the jwts we have

// System JWT: HS256 with shared secret

...

Added JWT signing standards to the System Architecture document's Authentication section under "JWT Tokens":

  • System JWT: HS256 with shared secret
  • User JWT: RS256 via JWKS from Better Auth

(commit: 2a963b9)

Copilot AI changed the title Add logging standards documentation with BetterStack reference Add logging standards documentation with BetterStack reference and JWT signing standards Feb 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants