@mecanizou/telemetry-hub 1.0.0 → 1.0.1

package/.github/workflows/pull_request.yml

@@ -1,32 +1,32 @@
-name: Pull Request
-
-on:
-  pull_request:
-    branches:
-      - master
-      - staging
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: '18.17.*'
-      - name: Install npm dependencies
-        run: npm install
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: Build
-        run: npm run build
-      - name: Unity Test
-        run: npm test
-  if_merged:
-    if: github.event.pull_request.merged == true
-    runs-on: ubuntu-latest
-    steps:
-      - run: |
-          echo The PR was merged
+name: Pull Request
+
+on:
+  pull_request:
+    branches:
+      - master
+      - staging
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.17.*'
+      - name: Install npm dependencies
+        run: npm install
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Build
+        run: npm run build
+      - name: Unity Test
+        run: npm test
+  if_merged:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          echo The PR was merged

package/.github/workflows/release.yml

@@ -1,129 +1,129 @@
-name: 🚀 Release
-
-on:
-  push:
-    branches:
-      - master
-      - alpha
-      - beta
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Repository
-        uses: actions/checkout@master
-        with:
-          fetch-depth: 0
-          persist-credentials: false
-
-      - name: Send Slack init message
-        uses: 8398a7/action-slack@v3
-        with:
-          status: "custom"
-          custom_payload: |
-            {
-              text: "${{ github.event.repository.name }} build initiated",
-              attachments: [{
-                color: '#5a9eda',
-                fields: [
-                  {
-                    title: 'Build initiated',
-                    value: "<https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}|${{ github.event.commits[0].message }}>",
-                    short: false,
-                  },
-                  {
-                    title: 'Branch',
-                    value: "${{ github.ref }}",
-                    short: true,
-                  },
-                  {
-                    title: 'Project',
-                    value: "${{ github.event.repository.name }}",
-                    short: true,
-                  },
-                  {
-                    title: 'Commit',
-                    value: "<${{ github.event.commits[0].url }}|${{ github.event.commits[0].id }}>",
-                    short: false,
-                  },
-                  {
-                    title: 'Author',
-                    value: "${{ github.actor }}",
-                    short: false,
-                  }
-                ],
-              }]
-            }
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-        if: always()
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "24.11.*"
-
-      - name: Install dependencies
-        run: npm install
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      # - name: Run Tests
-      #   run: npm test
-      - name: Build
-        run: npm run build
-
-      - name: Semantic Release
-        if: success()
-        run: npx semantic-release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      - name: Send Slack finish message
-        uses: 8398a7/action-slack@v3
-        with:
-          status: "custom"
-          custom_payload: |
-            {
-              text: '${{ github.event.repository.name }} build ${{ steps.set_build_details.outputs.status }}',
-              attachments: [{
-                color: '${{ steps.set_build_details.outputs.color }}',
-                fields: [
-                  {
-                    title: 'Build ${{ steps.set_build_details.outputs.status }}',
-                    value: "<https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}|${{ github.event.commits[0].message }}>",
-                    short: false,
-                  },
-                  {
-                    title: 'Branch',
-                    value: "${{ github.ref }}",
-                    short: true,
-                  },
-                  {
-                    title: 'Project',
-                    value: "${{ github.event.repository.name }}",
-                    short: true,
-                  },
-                  {
-                    title: 'Commit',
-                    value: "<${{ github.event.commits[0].url }}|${{ github.event.commits[0].id }}>",
-                    short: false,
-                  },
-                  {
-                    title: 'Author',
-                    value: "${{ github.actor }}",
-                    short: false,
-                  },
-                  {
-                    title: 'Duration',
-                    value: "${{ steps.set_build_details.outputs.time }}",
-                    short: false,
-                  },
-                ],
-              }]
-            }
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-        if: always()
+name: 🚀 Release
+
+on:
+  push:
+    branches:
+      - master
+      - alpha
+      - beta
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Send Slack init message
+        uses: 8398a7/action-slack@v3
+        with:
+          status: "custom"
+          custom_payload: |
+            {
+              text: "${{ github.event.repository.name }} build initiated",
+              attachments: [{
+                color: '#5a9eda',
+                fields: [
+                  {
+                    title: 'Build initiated',
+                    value: "<https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}|${{ github.event.commits[0].message }}>",
+                    short: false,
+                  },
+                  {
+                    title: 'Branch',
+                    value: "${{ github.ref }}",
+                    short: true,
+                  },
+                  {
+                    title: 'Project',
+                    value: "${{ github.event.repository.name }}",
+                    short: true,
+                  },
+                  {
+                    title: 'Commit',
+                    value: "<${{ github.event.commits[0].url }}|${{ github.event.commits[0].id }}>",
+                    short: false,
+                  },
+                  {
+                    title: 'Author',
+                    value: "${{ github.actor }}",
+                    short: false,
+                  }
+                ],
+              }]
+            }
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+        if: always()
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "24.11.*"
+
+      - name: Install dependencies
+        run: npm install
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      # - name: Run Tests
+      #   run: npm test
+      - name: Build
+        run: npm run build
+
+      - name: Semantic Release
+        if: success()
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Send Slack finish message
+        uses: 8398a7/action-slack@v3
+        with:
+          status: "custom"
+          custom_payload: |
+            {
+              text: '${{ github.event.repository.name }} build ${{ steps.set_build_details.outputs.status }}',
+              attachments: [{
+                color: '${{ steps.set_build_details.outputs.color }}',
+                fields: [
+                  {
+                    title: 'Build ${{ steps.set_build_details.outputs.status }}',
+                    value: "<https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}|${{ github.event.commits[0].message }}>",
+                    short: false,
+                  },
+                  {
+                    title: 'Branch',
+                    value: "${{ github.ref }}",
+                    short: true,
+                  },
+                  {
+                    title: 'Project',
+                    value: "${{ github.event.repository.name }}",
+                    short: true,
+                  },
+                  {
+                    title: 'Commit',
+                    value: "<${{ github.event.commits[0].url }}|${{ github.event.commits[0].id }}>",
+                    short: false,
+                  },
+                  {
+                    title: 'Author',
+                    value: "${{ github.actor }}",
+                    short: false,
+                  },
+                  {
+                    title: 'Duration',
+                    value: "${{ steps.set_build_details.outputs.time }}",
+                    short: false,
+                  },
+                ],
+              }]
+            }
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+        if: always()

package/.prettierignore

@@ -1,5 +1,5 @@
-# Ignore artifacts:
-package-lock.json
-lib
-coverage
+# Ignore artifacts:
+package-lock.json
+lib
+coverage
 dist

package/DOCS_GUIDE.md

@@ -0,0 +1,151 @@
+# 📚 Estrutura de Documentação
+
+Este documento ajuda a navegar pela documentação do Telemetry Hub.
+
+## 🗺️ Mapa da Documentação
+
+```
+📦 telemetry-hub/
+│
+├── 📄 README.md                    # ⭐ Início - Visão geral e quick start
+├── 📄 DOCS_GUIDE.md                # 🗺️ Mapa de navegação da documentação
+│
+├── 📁 src/telemetry/core/
+│   ├── 📄 README.md                 # 🎯 Visão geral do Core
+│   ├── 📄 LOGGING.md                # 📝 Guia detalhado de logs padronizados
+│   ├── 📄 TRACING.md                # 🔍 Guia detalhado de traces padronizados
+│   └── 📁 __tests__/
+│       └── 📄 README.md             # 🧪 Documentação dos testes (57 testes, 100% cobertura)
+│
+├── 📁 src/telemetry/tsed/
+│   ├── 📄 README.md                 # 🔷 Guia completo Tsed
+│   ├── 📄 EXAMPLES.md               # 💡 Exemplos práticos de uso Tsed
+│   ├── 📄 IMPLEMENTATION_SUMMARY.md # 📝 Resumo da implementação Tsed
+│   └── 📄 SST_COMPARISON.md         # ⚖️ Comparação detalhada Tsed vs SST
+│
+└── 📁 src/telemetry/sst/
+    ├── 📄 README.md                 # 🟦 Guia completo SST/Middy
+    └── 📄 EXAMPLES.md               # 💡 Exemplos práticos de uso SST
+```
+
+## 🎯 Por Objetivo
+
+### Quero começar a usar
+
+1. **Projeto Tsed:**
+   - [Tsed Quick Start](./src/telemetry/tsed/README.md)
+   - [Exemplos Práticos Tsed](./src/telemetry/tsed/EXAMPLES.md) 💡
+   - Copiar configuração de environment variables
+   - Adicionar `@TsedLogTelemetry()` nos controllers
+
+2. **Projeto SST:**
+   - [SST Quick Start](./src/telemetry/sst/README.md)
+   - [Exemplos Práticos SST](./src/telemetry/sst/EXAMPLES.md) 💡
+   - Copiar configuração de environment variables
+   - Adicionar `.use(middyMiddleware())` nos handlers
+
+### Quero entender os conceitos
+
+1. [LOGGING.md](./src/telemetry/core/LOGGING.md) - Como funciona o logging padronizado
+2. [TRACING.md](./src/telemetry/core/TRACING.md) - Como funciona o tracing padronizado
+3. [SST_COMPARISON.md](./src/telemetry/tsed/SST_COMPARISON.md) - Validação de paridade Tsed vs SST
+
+### Quero detalhes técnicos
+
+1. **Core:**
+   - [Core README](./src/telemetry/core/README.md) - Visão geral da implementação base
+   - [Logging](./src/telemetry/core/LOGGING.md) - Detalhes de StandardLogger
+   - [Tracing](./src/telemetry/core/TRACING.md) - Detalhes de StandardTracer
+   - [Tests README](./src/telemetry/core/__tests__/README.md) - Cobertura de testes
+
+2. **Tsed:**
+   - [Implementation Summary](./src/telemetry/tsed/IMPLEMENTATION_SUMMARY.md) - O que foi implementado
+   - [SST Comparison](./src/telemetry/tsed/SST_COMPARISON.md) - Validação de paridade
+
+3. **Código Fonte:**
+   - `src/telemetry/core/logger.ts` - StandardLogger
+   - `src/telemetry/core/tracer.ts` - StandardTracer
+   - `src/telemetry/tsed/log-telemetry.ts` - Decorator Tsed
+   - `src/telemetry/sst/middy/middleware.ts` - Middleware SST
+
+### Quero contribuir
+
+1. [README.md - Seção Contribuindo](./README.md#-contribuindo)
+2. [Tests README](./src/telemetry/core/__tests__/README.md) - Como escrever testes
+
+## 📖 Fluxo de Leitura Recomendado
+
+### Para Desenvolvedores Novos
+
+```
+1. README.md (visão geral)
+   ↓
+2. Guia do seu framework (Tsed ou SST)
+   ↓
+3. EXAMPLES.md (ver exemplos práticos) 💡
+   ↓
+4. core/LOGGING.md (entender logs)
+   ↓
+5. core/TRACING.md (entender traces)
+```
+
+### Para Desenvolvedores Avançados
+
+```
+1. Guia do framework (quick start)
+   ↓
+2. EXAMPLES.md (cenários reais) 💡
+   ↓
+3. IMPLEMENTATION_SUMMARY.md (arquitetura)
+   ↓
+4. SST_COMPARISON.md (validação de paridade)
+   ↓
+5. Código fonte (core/logger.ts, core/tracer.ts)
+```
+
+### Para Code Review
+
+```
+1. Tests README (ver cobertura)
+   ↓
+2. IMPLEMENTATION_SUMMARY.md (mudanças)
+   ↓
+3. SST_COMPARISON.md (validação)
+```
+
+## 🔍 Busca Rápida
+
+| Preciso de... | Onde encontrar |
+|--------------|----------------|
+| Visão geral do Core | [core/README.md](./src/telemetry/core/README.md) |
+| Exemplo de uso Tsed | [tsed/README.md](./src/telemetry/tsed/README.md) |
+| **Exemplos práticos Tsed** | **[tsed/EXAMPLES.md](./src/telemetry/tsed/EXAMPLES.md)** 💡 |
+| Exemplo de uso SST | [sst/README.md](./src/telemetry/sst/README.md) |
+| **Exemplos práticos SST** | **[sst/EXAMPLES.md](./src/telemetry/sst/EXAMPLES.md)** 💡 |
+| Campos de log disponíveis | [core/LOGGING.md](./src/telemetry/core/LOGGING.md) |
+| Campos de trace disponíveis | [core/TRACING.md](./src/telemetry/core/TRACING.md) |
+| Como funciona o decorator | [tsed/README.md - Decorator](./src/telemetry/tsed/README.md#-o-que-o-decorator-faz) |
+| Como funciona o middleware | [sst/README.md - Middleware](./src/telemetry/sst/README.md#-o-que-o-middleware-faz) |
+| Environment variables | [README.md - Configuração](./README.md#%EF%B8%8F-configuração) |
+| Cobertura de testes | [core/__tests__/README.md](./src/telemetry/core/__tests__/README.md) |
+| Tsed vs SST | [tsed/SST_COMPARISON.md](./src/telemetry/tsed/SST_COMPARISON.md) |
+| O que mudou no Tsed | [tsed/IMPLEMENTATION_SUMMARY.md](./src/telemetry/tsed/IMPLEMENTATION_SUMMARY.md) |
+
+## 📝 Convenções
+
+- **README.md** - Visão geral e quick start
+- **[NOME].md** (maiúsculo) - Guias conceituais
+- **[NOME]_[NOME].md** - Documentos de comparação/análise
+
+## 🎨 Ícones Usados
+
+- 📊 Telemetry Hub (biblioteca)
+- 🔷 Tsed (framework)
+- 🟦 SST (framework)
+- 🎯 Core (implementação base)
+- 📝 Logs
+- 🔍 Traces
+- 📈 Métricas
+- ✅ Validação/Sucesso
+- 🧪 Testes
+- 📚 Documentação