{"id":31582951,"url":"https://github.com/teachmehipaa/aperture","last_synced_at":"2026-05-18T10:38:51.838Z","repository":{"id":315938961,"uuid":"1061322868","full_name":"TeachMeHIPAA/aperture","owner":"TeachMeHIPAA","description":"Yet another observability toolkit for Node.js","archived":false,"fork":false,"pushed_at":"2025-09-27T19:08:09.000Z","size":339,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-27T21:08:06.852Z","etag":null,"topics":["logging","logging-and-metrics","nuxt","observability","pluggable-transports"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TeachMeHIPAA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-21T17:25:40.000Z","updated_at":"2025-09-25T16:07:41.000Z","dependencies_parsed_at":"2025-09-27T21:08:11.292Z","dependency_job_id":null,"html_url":"https://github.com/TeachMeHIPAA/aperture","commit_stats":null,"previous_names":["nficano/aperture","teachmehipaa/aperture"],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/TeachMeHIPAA/aperture","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeachMeHIPAA%2Faperture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeachMeHIPAA%2Faperture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeachMeHIPAA%2Faperture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeachMeHIPAA%2Faperture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeachMeHIPAA","download_url":"https://codeload.github.com/TeachMeHIPAA/aperture/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeachMeHIPAA%2Faperture/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278537766,"owners_count":26003250,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-05T02:00:06.059Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["logging","logging-and-metrics","nuxt","observability","pluggable-transports"],"created_at":"2025-10-05T23:56:14.577Z","updated_at":"2025-10-05T23:56:16.727Z","avatar_url":"https://github.com/TeachMeHIPAA.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"http://assets.nickficano.com/aperture-logo-dark.svg\" /\u003e\n    \u003cimg src=\"http://assets.nickficano.com/aperture-logo-light.svg\" alt=\"Aperture\" width=\"438\" height=\"94\" /\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n# Aperture\n\nAperture is a domain-driven observability toolkit tailored for Nuxt and Node.js services. It unifies structured logging, instrumentation, and provider orchestration so teams can capture business context, impact, and customer journeys with minimal ceremony.\n\n[![npm version](https://img.shields.io/npm/v/%40nficano%2Faperture)](https://www.npmjs.com/package/@nficano/aperture)\n[![npm downloads](https://img.shields.io/npm/dm/%40nficano%2Faperture)](https://www.npmjs.com/package/@nficano/aperture)\n[![types](https://img.shields.io/npm/types/%40nficano%2Faperture)](https://www.npmjs.com/package/@nficano/aperture)\n[![node](https://img.shields.io/node/v/%40nficano%2Faperture)](package.json)\n\n## Notice:\n\n**Aperture is still a work-in-progress. I don't suggest relying on it**\n\n## Highlights\n\n- **Domain + impact-aware logging**: scope every event to business domains and impact classes (revenue, engagement, performance, reliability).\n- **User journey instruments**: trace funnels, API calls, and conversions with async-safe context propagation.\n- **Pluggable providers**: console (rich dev output), Firebase, Sentry, Datadog, New Relic, or any HTTP endpoint.\n- **Async context management**: leverage `AsyncLocalStorage` to keep tags, user traits, and instrumentation data across awaits.\n\n## Getting Started\n\n```bash\nnpm install @nficano/aperture\n```\n\n### Nuxt Integration\n\n1. Enable the module in `nuxt.config.ts`:\n\n```ts\nexport default defineNuxtConfig({\n  modules: [\"@nficano/aperture/nuxt\"],\n  aperture: {\n    environment: process.env.NODE_ENV,\n    defaultTags: { service: \"nuxt-app\" },\n    domains: [\n      { name: \"auth\", defaultImpact: \"reliability\" },\n      { name: \"content\", defaultImpact: \"engagement\" },\n    ],\n    providers: {\n      console: true,\n      sentry: process.env.SENTRY_DSN\n        ? { dsn: process.env.SENTRY_DSN, tracesSampleRate: 1.0 }\n        : false,\n      datadog: process.env.DATADOG_API_KEY\n        ? { apiKey: process.env.DATADOG_API_KEY, service: \"nuxt-app\" }\n        : false,\n    },\n  },\n});\n```\n\n2. Use the injected logger inside middleware or composables:\n\n```ts\nexport default defineEventHandler(async (event) =\u003e {\n  const { $apertureLogger } = event.context.nuxt;\n\n  const authLogger = $apertureLogger\n    .withDomain(\"auth\")\n    .withImpact(\"reliability\")\n    .withTags({ route: event.path });\n\n  const instrument = instrumentApiCall(authLogger, \"POST /api/login\");\n\n  return instrument.run(async () =\u003e {\n    // ... auth logic\n    return { status: \"ok\" };\n  });\n});\n```\n\n### Node.js Service\n\n```ts\nimport { Aperture, ConsoleProvider, instrumentFunnel } from \"@nficano/aperture\";\n\nconst aperture = new Aperture({\n  environment: process.env.NODE_ENV ?? \"development\",\n  defaultTags: { service: \"checkout-service\" },\n  domains: [{ name: \"ecommerce\", defaultImpact: \"revenue\" }],\n});\n\nautowire();\n\nconst logger = aperture.getLogger().withDomain(\"ecommerce\");\n\nasync function handleCheckout(orderId: string) {\n  return instrumentFunnel(logger, \"checkout-flow\", {\n    impact: \"revenue\",\n    tags: { orderId },\n  }).run(async () =\u003e {\n    logger.info(\"Cart validated\", { impact: \"engagement\" });\n    logger.info(\"Payment authorized\", { impact: \"revenue\" });\n  });\n}\n\nfunction autowire() {\n  aperture.registerProvider(new ConsoleProvider());\n  if (process.env.DATADOG_API_KEY) {\n    aperture.registerProvider(\n      new DatadogProvider({\n        apiKey: process.env.DATADOG_API_KEY,\n        service: \"checkout-service\",\n      })\n    );\n  }\n}\n```\n\n### Provider Injection\n\n- Development: console-only rich logs.\n- Production: layer any combination of Firebase, Sentry, Datadog, or New Relic.\n\n```ts\nconst aperture = new Aperture({ environment: \"production\" });\naperture.registerProvider(new ConsoleProvider({ enableColors: false }));\naperture.registerProvider(new SentryProvider({ dsn: process.env.SENTRY_DSN }));\naperture.registerProvider(\n  new DatadogProvider({\n    apiKey: process.env.DATADOG_API_KEY!,\n    service: \"public-api\",\n  })\n);\n```\n\n### Instruments Cheat-Sheet\n\n```ts\nconst journey = instrumentUserJourney(logger, \"onboarding\", {\n  impact: \"engagement\",\n});\nawait journey\n  .step({ step: \"start\" })\n  .annotate({ plan: \"pro\" })\n  .run(async () =\u003e {\n    await instrumentApiCall(logger, \"POST /api/send-welcome\").run(\n      callWelcomeApi\n    );\n    await instrumentConversion(logger, \"trial-to-paid\", {\n      impact: \"revenue\",\n    }).run(upgradeUser);\n  });\n```\n\n## Repository Map\n\n- `src/core/*`: logging, context, domains, and instrumentation primitives.\n- `src/providers/*`: first-party provider implementations.\n- `src/integrations/*`: framework integrations (e.g., Nuxt module + runtime plugin).\n- `examples/*`: end-to-end usage snippets.\n\n---\n\nAperture is designed to grow with your observability stack—compose new providers, enrich domains, and track funnels without losing sight of the business impact behind every metric.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteachmehipaa%2Faperture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteachmehipaa%2Faperture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteachmehipaa%2Faperture/lists"}