@shellicar/winston-azure-application-insights 5.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Stephen Hellicar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,147 @@
+@shellicar/winston-azure-application-insights
+==================================
+
+## Update
+
+This has been forked as the original and other forks have not been updated in quite a while.
+
+Most of this README has been left as is, with relevant updates only.
+
+## Intro
+
+An [Azure Application Insights][0] transport for [Winston][1] logging library.
+
+This transport is designed to make it easy to obtain a reference to a standard logging library that broadcasts to Application Insights.
+
+Your logging interface can remain familiar to standard (`logger.info`, `logger.error` etc) without intertwining any Azure-specific implementation detail. 
+
+**[Read the project changelog](./CHANGELOG.md)**  
+
+## Installation
+
+```sh
+pnpm install @shellicar/winston-azure-application-insights
+```
+
+## Support
+
+This library has CJS and ESM outputs.
+
+Continuous integration tests are run against the NodeJS LTS versions.
+
+## Usage
+
+See `demo.ts` and the `examples` directory for a usage examples.
+
+**Connection String**
+
+**Note**: an connection string is required before any data can be sent. Please see the
+"[Connection Strings in Application Insights](https://learn.microsoft.com/en-us/azure/azure-monitor/app/sdk-connection-string?tabs=dotnet5#find-your-connection-string)"
+for more information.
+
+The connection string can be supplied:
+
+* Passing an initialized Application Insights client in the "client" options property:
+
+```typescript
+import { setup, defaultClient } from 'applicationinsights';
+import { AzureApplicationInsightsLogger } from '@shellicar/winston-azure-application-insights';
+
+setup().start();
+
+const insightsLogger = new AzureApplicationInsightsLogger({
+  client: defaultClient,
+});
+```
+```cjs
+const { setup, defaultClient } = require("applicationinsights");
+const { AzureApplicationInsightsLogger } = require('@shellicar/winston-azure-application-insights');
+
+setup(process.env.APPLICATIONINSIGHTS_CONNECTION_STRING).start();
+
+const insightsLogger = new AzureApplicationInsightsLogger({
+  client: defaultClient,
+});
+```
+
+**I get an error when using this transport**
+
+If you receive the error:
+
+`No instrumentation key or connection string was provided to the Azure Monitor Exporter`
+
+Then you didn't specify a suitable instrumentation key. See the section above.
+
+`Error: @opentelemetry/api: Attempted duplicate registration of API: context`
+
+This may be because your environment has already (maybe implicitly) loaded applicationinsights and called `.setup()`.
+This happens if you are running an Azure Function App and have `APPLICATIONINSIGHTS_CONNECTION_STRING` set.
+The best solution to this is to load `applicationinsights` and pass in `appInsights.defaultClient` using the `client`
+option as per example.
+
+**I'm seeing multiple traces with similar/identical messages**
+
+`applicationinsights` deeply integrates into the `console` transports, and `winston` itself (via `diagnostic-channel`).
+If you are integrating this transport, it's recommended to disable `diagnostic-channel` and console auto collection:
+
+To control `diagnostic-channel`, [follow the guide in the main repository](https://github.com/Microsoft/ApplicationInsights-node.js#automatic-third-party-instrumentation).
+
+It is recommended to use _only_ this transport where your application is running in production mode and needs to
+stream data to Application Insights. In all other scenarios such as local debug and test suites, the console transport
+(or similar) should suffice. This is to avoid polluting instances/unnecessary cost.
+
+Despite this notice, to specifically disable console transport collection, use `.setAutoCollectConsole(false)`:
+
+```js
+setup().setAutoCollectConsole(false);
+```
+
+## Options
+
+* **level**: lowest logging level transport to be logged (default: `info`)
+* **sendErrorsAsExceptions**: Boolean flag indicating whether to also track errors to the AI exceptions table.
+See section below for more details (default: `true`).
+
+**SDK integration options (required):**
+
+* **client**: An existing App Insights client
+
+## Log Levels
+
+Supported log levels are:
+
+Winston Level | App Insights level
+---------------|------------------
+error          | error (3)
+warn           | warning (2)
+info           | informational (1)
+verbose        | verbose (0)
+debug          | verbose (0)
+silly          | verbose (0)
+
+**All other possible levels, or custom levels, will default to `info`**
+
+[0]: https://azure.microsoft.com/en-us/services/application-insights/
+[1]: https://github.com/winstonjs/winston
+
+## Error & Exception Logging: Exceptions vs. Traces
+
+The Application Insights "exceptions" table allows you to see more detailed error information including the stack trace.
+Therefore for all log events at severity level error or above, an exception is logged if the library detects that an
+Error object has been passed.
+The log event will still generate a trace with the correct severity level regardless of this setting, but please note
+that any Error object will have its `stack` property omitted when sent to `trackTrace`.
+All other properties are included.
+
+This allows you to see clearly Azure Application Insights instead of having to access trace information manually and set
+up alerts based on the related metrics.
+
+How it works with `sendErrorsAsExceptions: true`:
+
+* `logger.error('error message');` creates a trace with severity level 3; *no* exception is tracked
+* `logger.error(new Error('error message'));` creates a trace with severity level 3, *and* an exception with the Error object as argument
+* `logger.error('error message', new Error('error message'));` creates a trace with severity level 3, *and* an exception with the Error object as argument
+* `logger.error(new Error('error message'), logContext);` creates a trace and exception and logContext is set to the customDimensions (properties) track* field
+* `logger.info(new Error('error message'));` creates a trace with severity level 1; *no* exception is tracked
+
+If you do not wish to track exceptions, you can set the option `sendErrorsAsExceptions: false` when configuring the transport.

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("applicationinsights");function t(e){return e&&e.__esModule?e:{default:e}}var r=t(require("winston-transport")),s=Object.defineProperty,n=(e,t)=>s(e,"name",{value:t,configurable:!0}),i={0:e.KnownSeverityLevel.Verbose,1:e.KnownSeverityLevel.Information,2:e.KnownSeverityLevel.Warning,3:e.KnownSeverityLevel.Error,4:e.KnownSeverityLevel.Critical},o=n((e=>({emerg:4,alert:4,crit:4,error:3,warning:2,warn:2,notice:1,info:1,verbose:0,debug:0,silly:0}[e]??1)),"getMessageLevel"),c=n((e=>e instanceof Error),"isErrorLike"),l=n((e=>null!==e&&"object"==typeof e&&Object.getPrototypeOf(e)===Object.prototype),"isPlainObject"),a=n((e=>"object"!=typeof e||l(e)?e:Object.assign({},e)),"convertToPlainObject"),p=n((e=>{const t=["level","message"];return Object.keys(e).filter((e=>!t.includes(e))).reduce(((t,r)=>{const s=e[r];return t[r]=a(s),t}),{})}),"extractPropsFromInfo"),g=n((e=>{const t={message:e.message};for(const[r,s]of Object.entries(e))"stack"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&(t[r]=a(s));return t}),"extractErrorPropsForTrace"),f=class extends r.default{static{n(this,"AzureApplicationInsightsLogger")}client;sendErrorsAsExceptions;name;constructor(e){super({level:e.level??"info",silent:e.silent??!1}),this.client=e.client,this.name="applicationinsightslogger",this.sendErrorsAsExceptions=e.sendErrorsAsExceptions??!0}handleTrace(e,t,r,s){const n=p(t);let o;c(t)?o=t:c(r)?o=r:c(s)&&(o=s),o&&Object.assign(n,g(o)),s!==o&&Object.assign(n,s),this.client.trackTrace({message:String(r),severity:i[e],properties:n})}handleException(e,t,r){const s={};let n;if(c(e))n=e;else if(c(t))n=t;else{if(!c(r))return;n=r}"string"==typeof t&&n.message!==t&&(s.message=t),n!==r&&Object.assign(s,r),this.client.trackException({exception:n,properties:s})}log(e,t){const{level:r,message:s}=e,n=o(r),i=Reflect.get(e,Symbol.for("splat"))??[],c=i.length?i[0]:{};this.handleTrace(n,e,s,c),this.sendErrorsAsExceptions&&n>=3&&this.handleException(e,s,c),t()}};exports.AzureApplicationInsightsLogger=f;//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/winston-azure-application-insights.ts"],"names":["KnownSeverityLevel","TransportStream"],"mappings":";;;;;;;;;;;AAaA,IAAM,mBAAiE,GAAA;AAAA,EACrE,CAAC,CAAqB,iBAAGA,sCAAmB,CAAA,OAAA;AAAA,EAC5C,CAAC,CAAyB,qBAAGA,sCAAmB,CAAA,WAAA;AAAA,EAChD,CAAC,CAAqB,iBAAGA,sCAAmB,CAAA,OAAA;AAAA,EAC5C,CAAC,CAAmB,eAAGA,sCAAmB,CAAA,KAAA;AAAA,EAC1C,CAAC,CAAsB,kBAAGA,sCAAmB,CAAA,QAAA;AAC/C,CAAA,CAAA;AAGA,IAAM,eAAA,2BAAmB,YAAwC,KAAA;AAC/D,EAAA,MAAM,MAAwC,GAAA;AAAA,IAC5C,KAAO,EAAA,CAAA;AAAA,IACP,KAAO,EAAA,CAAA;AAAA,IACP,IAAM,EAAA,CAAA;AAAA,IACN,KAAO,EAAA,CAAA;AAAA,IACP,OAAS,EAAA,CAAA;AAAA,IACT,IAAM,EAAA,CAAA;AAAA,IACN,MAAQ,EAAA,CAAA;AAAA,IACR,IAAM,EAAA,CAAA;AAAA,IACN,OAAS,EAAA,CAAA;AAAA,IACT,KAAO,EAAA,CAAA;AAAA,IACP,KAAO,EAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAO,OAAA,MAAA,CAAO,YAAY,CAAK,IAAA,CAAA,mBAAA;AACjC,CAhBwB,EAAA,iBAAA,CAAA,CAAA;AAkBxB,IAAM,WAAA,2BAAe,GAA+B,KAAA;AAClD,EAAA,OAAO,GAAe,YAAA,KAAA,CAAA;AACxB,CAFoB,EAAA,aAAA,CAAA,CAAA;AAKpB,IAAM,aAAA,2BAAiB,GAAqC,KAAA;AAC1D,EAAO,OAAA,GAAA,KAAQ,QAAQ,OAAO,GAAA,KAAQ,YAAY,MAAO,CAAA,cAAA,CAAe,GAAG,CAAA,KAAM,MAAO,CAAA,SAAA,CAAA;AAC1F,CAFsB,EAAA,eAAA,CAAA,CAAA;AAItB,IAAM,oBAAA,2BAAwB,GAA0B,KAAA;AACtD,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AAC3B,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACA,EAAI,IAAA,aAAA,CAAc,GAAG,CAAG,EAAA;AACtB,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACA,EAAA,OAAO,MAAO,CAAA,MAAA,CAAO,EAAC,EAAG,GAAG,CAAA,CAAA;AAC9B,CAR6B,EAAA,sBAAA,CAAA,CAAA;AAU7B,IAAM,oBAAA,2BAAwB,IAAmC,KAAA;AAC/D,EAAM,MAAA,OAAA,GAAU,CAAC,OAAA,EAAS,SAAS,CAAA,CAAA;AAEnC,EAAA,OAAO,OAAO,IAAK,CAAA,IAAI,CACpB,CAAA,MAAA,CAAO,CAAC,GAAQ,KAAA,CAAC,OAAQ,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA,CACtC,MAAoB,CAAA,CAAC,OAAO,GAAQ,KAAA;AACnC,IAAM,MAAA,KAAA,GAAQ,KAAK,GAAG,CAAA,CAAA;AACtB,IAAM,KAAA,CAAA,GAAG,CAAI,GAAA,oBAAA,CAAqB,KAAK,CAAA,CAAA;AACvC,IAAO,OAAA,KAAA,CAAA;AAAA,GACT,EAAG,EAAE,CAAA,CAAA;AACT,CAV6B,EAAA,sBAAA,CAAA,CAAA;AAY7B,IAAM,yBAAA,2BAA6B,SAAkC,KAAA;AACnE,EAAA,MAAM,UAA0B,GAAA;AAAA,IAC9B,SAAS,SAAU,CAAA,OAAA;AAAA,GACrB,CAAA;AACA,EAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,SAAS,CAAG,EAAA;AACpD,IAAI,IAAA,GAAA,KAAQ,WAAW,MAAO,CAAA,SAAA,CAAU,eAAe,IAAK,CAAA,SAAA,EAAW,GAAG,CAAG,EAAA;AAC3E,MAAW,UAAA,CAAA,GAAG,CAAI,GAAA,oBAAA,CAAqB,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AACA,EAAO,OAAA,UAAA,CAAA;AACT,CAVkC,EAAA,2BAAA,CAAA,CAAA;AAmBrB,IAAA,8BAAA,GAAN,cAA6CC,gCAAgB,CAAA;AAAA,EA1FpE;AA0FoE,IAAA,MAAA,CAAA,IAAA,EAAA,gCAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAClD,MAAA,CAAA;AAAA,EACT,sBAAA,CAAA;AAAA,EACE,IAAA,CAAA;AAAA,EAET,YAAY,OAAgD,EAAA;AAC1D,IAAM,KAAA,CAAA,EAAE,OAAO,OAAQ,CAAA,KAAA,IAAS,QAAQ,MAAQ,EAAA,OAAA,CAAQ,MAAU,IAAA,KAAA,EAAO,CAAA,CAAA;AACzE,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,IAAO,GAAA,2BAAA,CAAA;AACZ,IAAK,IAAA,CAAA,sBAAA,GAAyB,QAAQ,sBAA0B,IAAA,IAAA,CAAA;AAAA,GAClE;AAAA,EAEQ,WAAY,CAAA,QAAA,EAAyB,IAAmB,EAAA,OAAA,EAA6B,OAA4B,EAAA;AACvH,IAAM,MAAA,UAAA,GAAa,qBAAqB,IAAI,CAAA,CAAA;AAC5C,IAAI,IAAA,QAAA,CAAA;AAEJ,IAAI,IAAA,WAAA,CAAY,IAAI,CAAG,EAAA;AACrB,MAAW,QAAA,GAAA,IAAA,CAAA;AAAA,KACb,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAW,QAAA,GAAA,OAAA,CAAA;AAAA,KACb,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAW,QAAA,GAAA,OAAA,CAAA;AAAA,KACb;AAEA,IAAA,IAAI,QAAU,EAAA;AACZ,MAAA,MAAA,CAAO,MAAO,CAAA,UAAA,EAAY,yBAA0B,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,KAC/D;AAEA,IAAA,IAAI,YAAY,QAAU,EAAA;AACxB,MAAO,MAAA,CAAA,MAAA,CAAO,YAAY,OAAO,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,IAAA,CAAK,OAAO,UAAW,CAAA;AAAA,MACrB,OAAA,EAAS,OAAO,OAAO,CAAA;AAAA,MACvB,QAAA,EAAU,oBAAoB,QAAQ,CAAA;AAAA,MACtC,UAAY,EAAA,UAAA;AAAA,KACb,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,eAAA,CAAgB,IAAmB,EAAA,OAAA,EAA6B,OAA4B,EAAA;AAClG,IAAA,MAAM,iBAA8B,EAAC,CAAA;AACrC,IAAI,IAAA,SAAA,CAAA;AAEJ,IAAI,IAAA,WAAA,CAAY,IAAI,CAAG,EAAA;AACrB,MAAY,SAAA,GAAA,IAAA,CAAA;AAAA,KACd,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAY,SAAA,GAAA,OAAA,CAAA;AAAA,KACd,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAY,SAAA,GAAA,OAAA,CAAA;AAAA,KACP,MAAA;AACL,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAI,OAAO,OAAA,KAAY,QAAY,IAAA,SAAA,CAAU,YAAY,OAAS,EAAA;AAChE,MAAA,cAAA,CAAe,OAAU,GAAA,OAAA,CAAA;AAAA,KAC3B;AAEA,IAAA,IAAI,cAAc,OAAS,EAAA;AACzB,MAAO,MAAA,CAAA,MAAA,CAAO,gBAAgB,OAAO,CAAA,CAAA;AAAA,KACvC;AAEA,IAAA,IAAA,CAAK,OAAO,cAAe,CAAA,EAAE,SAAW,EAAA,UAAA,EAAY,gBAAgB,CAAA,CAAA;AAAA,GACtE;AAAA,EAES,GAAA,CAAI,MAAmB,QAA4B,EAAA;AAC1D,IAAM,MAAA,EAAE,KAAO,EAAA,OAAA,EAAY,GAAA,IAAA,CAAA;AAC3B,IAAM,MAAA,QAAA,GAAW,gBAAgB,KAAK,CAAA,CAAA;AACtC,IAAM,MAAA,KAAA,GAAQ,QAAQ,GAAI,CAAA,IAAA,EAAM,OAAO,GAAI,CAAA,OAAO,CAAC,CAAA,IAAK,EAAC,CAAA;AACzD,IAAA,MAAM,UAAU,KAAM,CAAA,MAAA,GAAS,KAAM,CAAA,CAAC,IAAI,EAAC,CAAA;AAE3C,IAAA,IAAA,CAAK,WAAY,CAAA,QAAA,EAAU,IAAM,EAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAEjD,IAAI,IAAA,IAAA,CAAK,sBAA0B,IAAA,QAAA,IAAY,CAAqB,cAAA;AAClE,MAAK,IAAA,CAAA,eAAA,CAAgB,IAAM,EAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAAA,KAC7C;AAEA,IAAS,QAAA,EAAA,CAAA;AAAA,GACX;AACF","file":"index.cjs","sourcesContent":["import { TelemetryClient, KnownSeverityLevel } from 'applicationinsights';\nimport TransportStream from 'winston-transport';\n\ntype PlainObject = Record<string, any>;\n\nenum SeverityLevel {\n  Verbose = 0,\n  Information = 1,\n  Warning = 2,\n  Error = 3,\n  Critical = 4,\n}\n\nconst knownSeverityLevels: Record<SeverityLevel, KnownSeverityLevel> = {\n  [SeverityLevel.Verbose]: KnownSeverityLevel.Verbose,\n  [SeverityLevel.Information]: KnownSeverityLevel.Information,\n  [SeverityLevel.Warning]: KnownSeverityLevel.Warning,\n  [SeverityLevel.Error]: KnownSeverityLevel.Error,\n  [SeverityLevel.Critical]: KnownSeverityLevel.Critical,\n};\n\n\nconst getMessageLevel = (winstonLevel: string): SeverityLevel => {\n  const levels: Record<string, SeverityLevel> = {\n    emerg: SeverityLevel.Critical,\n    alert: SeverityLevel.Critical,\n    crit: SeverityLevel.Critical,\n    error: SeverityLevel.Error,\n    warning: SeverityLevel.Warning,\n    warn: SeverityLevel.Warning,\n    notice: SeverityLevel.Information,\n    info: SeverityLevel.Information,\n    verbose: SeverityLevel.Verbose,\n    debug: SeverityLevel.Verbose,\n    silly: SeverityLevel.Verbose,\n  } as const;\n\n  return levels[winstonLevel] ?? SeverityLevel.Information;\n};\n\nconst isErrorLike = (obj: unknown): obj is Error => {\n  return obj instanceof Error;\n};\n\n\nconst isPlainObject = (obj: unknown): obj is PlainObject => {\n  return obj !== null && typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype;\n};\n\nconst convertToPlainObject = (obj: any): PlainObject => {\n  if (typeof obj !== 'object') {\n    return obj;\n  }\n  if (isPlainObject(obj)) {\n    return obj;\n  }\n  return Object.assign({}, obj);\n};\n\nconst extractPropsFromInfo = (info: PlainObject): PlainObject => {\n  const exclude = ['level', 'message'];\n\n  return Object.keys(info)\n    .filter((key) => !exclude.includes(key))\n    .reduce<PlainObject>((props, key) => {\n      const value = info[key];\n      props[key] = convertToPlainObject(value);\n      return props;\n    }, {});\n};\n\nconst extractErrorPropsForTrace = (errorLike: Error): PlainObject => {\n  const properties: PlainObject = {\n    message: errorLike.message,\n  };\n  for (const [key, value] of Object.entries(errorLike)) {\n    if (key !== 'stack' && Object.prototype.hasOwnProperty.call(errorLike, key)) {\n      properties[key] = convertToPlainObject(value);\n    }\n  }\n  return properties;\n};\n\nexport interface AzureApplicationInsightsLoggerOptions {\n  client: TelemetryClient;\n  level?: string;\n  silent?: boolean;\n  sendErrorsAsExceptions?: boolean;\n}\n\nexport class AzureApplicationInsightsLogger extends TransportStream {\n  public readonly client: TelemetryClient;\n  public sendErrorsAsExceptions: boolean;\n  readonly name: string;\n\n  constructor(options: AzureApplicationInsightsLoggerOptions) {\n    super({ level: options.level ?? 'info', silent: options.silent ?? false });\n    this.client = options.client;\n    this.name = 'applicationinsightslogger';\n    this.sendErrorsAsExceptions = options.sendErrorsAsExceptions ?? true;\n  }\n\n  private handleTrace(severity: SeverityLevel, info: PlainObject, message: string | undefined, logMeta: PlainObject): void {\n    const traceProps = extractPropsFromInfo(info);\n    let errorArg: Error | undefined;\n\n    if (isErrorLike(info)) {\n      errorArg = info;\n    } else if (isErrorLike(message)) {\n      errorArg = message as unknown as Error;\n    } else if (isErrorLike(logMeta)) {\n      errorArg = logMeta;\n    }\n\n    if (errorArg) {\n      Object.assign(traceProps, extractErrorPropsForTrace(errorArg));\n    }\n\n    if (logMeta !== errorArg) {\n      Object.assign(traceProps, logMeta);\n    }\n\n    this.client.trackTrace({\n      message: String(message),\n      severity: knownSeverityLevels[severity],\n      properties: traceProps,\n    });\n  }\n\n  private handleException(info: PlainObject, message: string | undefined, logMeta: PlainObject): void {\n    const exceptionProps: PlainObject = {};\n    let exception: Error | undefined;\n\n    if (isErrorLike(info)) {\n      exception = info;\n    } else if (isErrorLike(message)) {\n      exception = message as unknown as Error;\n    } else if (isErrorLike(logMeta)) {\n      exception = logMeta;\n    } else {\n      return;\n    }\n\n    if (typeof message === 'string' && exception.message !== message) {\n      exceptionProps.message = message;\n    }\n\n    if (exception !== logMeta) {\n      Object.assign(exceptionProps, logMeta);\n    }\n\n    this.client.trackException({ exception, properties: exceptionProps });\n  }\n\n  override log(info: PlainObject, callback: () => void): void {\n    const { level, message } = info;\n    const severity = getMessageLevel(level);\n    const splat = Reflect.get(info, Symbol.for('splat')) ?? [];\n    const logMeta = splat.length ? splat[0] : {};\n\n    this.handleTrace(severity, info, message, logMeta);\n\n    if (this.sendErrorsAsExceptions && severity >= SeverityLevel.Error) {\n      this.handleException(info, message, logMeta);\n    }\n\n    callback();\n  }\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { TelemetryClient } from 'applicationinsights';
+import TransportStream from 'winston-transport';
+
+type PlainObject = Record<string, any>;
+interface AzureApplicationInsightsLoggerOptions {
+    client: TelemetryClient;
+    level?: string;
+    silent?: boolean;
+    sendErrorsAsExceptions?: boolean;
+}
+declare class AzureApplicationInsightsLogger extends TransportStream {
+    readonly client: TelemetryClient;
+    sendErrorsAsExceptions: boolean;
+    readonly name: string;
+    constructor(options: AzureApplicationInsightsLoggerOptions);
+    private handleTrace;
+    private handleException;
+    log(info: PlainObject, callback: () => void): void;
+}
+
+export { AzureApplicationInsightsLogger, type AzureApplicationInsightsLoggerOptions };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{KnownSeverityLevel as e}from"applicationinsights";import t from"winston-transport";var r=Object.defineProperty,s=(e,t)=>r(e,"name",{value:t,configurable:!0}),n={0:e.Verbose,1:e.Information,2:e.Warning,3:e.Error,4:e.Critical},o=s((e=>({emerg:4,alert:4,crit:4,error:3,warning:2,warn:2,notice:1,info:1,verbose:0,debug:0,silly:0}[e]??1)),"getMessageLevel"),i=s((e=>e instanceof Error),"isErrorLike"),c=s((e=>null!==e&&"object"==typeof e&&Object.getPrototypeOf(e)===Object.prototype),"isPlainObject"),a=s((e=>"object"!=typeof e||c(e)?e:Object.assign({},e)),"convertToPlainObject"),l=s((e=>{const t=["level","message"];return Object.keys(e).filter((e=>!t.includes(e))).reduce(((t,r)=>{const s=e[r];return t[r]=a(s),t}),{})}),"extractPropsFromInfo"),p=s((e=>{const t={message:e.message};for(const[r,s]of Object.entries(e))"stack"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&(t[r]=a(s));return t}),"extractErrorPropsForTrace"),g=class extends t{static{s(this,"AzureApplicationInsightsLogger")}client;sendErrorsAsExceptions;name;constructor(e){super({level:e.level??"info",silent:e.silent??!1}),this.client=e.client,this.name="applicationinsightslogger",this.sendErrorsAsExceptions=e.sendErrorsAsExceptions??!0}handleTrace(e,t,r,s){const o=l(t);let c;i(t)?c=t:i(r)?c=r:i(s)&&(c=s),c&&Object.assign(o,p(c)),s!==c&&Object.assign(o,s),this.client.trackTrace({message:String(r),severity:n[e],properties:o})}handleException(e,t,r){const s={};let n;if(i(e))n=e;else if(i(t))n=t;else{if(!i(r))return;n=r}"string"==typeof t&&n.message!==t&&(s.message=t),n!==r&&Object.assign(s,r),this.client.trackException({exception:n,properties:s})}log(e,t){const{level:r,message:s}=e,n=o(r),i=Reflect.get(e,Symbol.for("splat"))??[],c=i.length?i[0]:{};this.handleTrace(n,e,s,c),this.sendErrorsAsExceptions&&n>=3&&this.handleException(e,s,c),t()}};export{g as AzureApplicationInsightsLogger};//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/winston-azure-application-insights.ts"],"names":[],"mappings":";;;;;AAaA,IAAM,mBAAiE,GAAA;AAAA,EACrE,CAAC,CAAqB,iBAAG,kBAAmB,CAAA,OAAA;AAAA,EAC5C,CAAC,CAAyB,qBAAG,kBAAmB,CAAA,WAAA;AAAA,EAChD,CAAC,CAAqB,iBAAG,kBAAmB,CAAA,OAAA;AAAA,EAC5C,CAAC,CAAmB,eAAG,kBAAmB,CAAA,KAAA;AAAA,EAC1C,CAAC,CAAsB,kBAAG,kBAAmB,CAAA,QAAA;AAC/C,CAAA,CAAA;AAGA,IAAM,eAAA,2BAAmB,YAAwC,KAAA;AAC/D,EAAA,MAAM,MAAwC,GAAA;AAAA,IAC5C,KAAO,EAAA,CAAA;AAAA,IACP,KAAO,EAAA,CAAA;AAAA,IACP,IAAM,EAAA,CAAA;AAAA,IACN,KAAO,EAAA,CAAA;AAAA,IACP,OAAS,EAAA,CAAA;AAAA,IACT,IAAM,EAAA,CAAA;AAAA,IACN,MAAQ,EAAA,CAAA;AAAA,IACR,IAAM,EAAA,CAAA;AAAA,IACN,OAAS,EAAA,CAAA;AAAA,IACT,KAAO,EAAA,CAAA;AAAA,IACP,KAAO,EAAA,CAAA;AAAA,GACT,CAAA;AAEA,EAAO,OAAA,MAAA,CAAO,YAAY,CAAK,IAAA,CAAA,mBAAA;AACjC,CAhBwB,EAAA,iBAAA,CAAA,CAAA;AAkBxB,IAAM,WAAA,2BAAe,GAA+B,KAAA;AAClD,EAAA,OAAO,GAAe,YAAA,KAAA,CAAA;AACxB,CAFoB,EAAA,aAAA,CAAA,CAAA;AAKpB,IAAM,aAAA,2BAAiB,GAAqC,KAAA;AAC1D,EAAO,OAAA,GAAA,KAAQ,QAAQ,OAAO,GAAA,KAAQ,YAAY,MAAO,CAAA,cAAA,CAAe,GAAG,CAAA,KAAM,MAAO,CAAA,SAAA,CAAA;AAC1F,CAFsB,EAAA,eAAA,CAAA,CAAA;AAItB,IAAM,oBAAA,2BAAwB,GAA0B,KAAA;AACtD,EAAI,IAAA,OAAO,QAAQ,QAAU,EAAA;AAC3B,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACA,EAAI,IAAA,aAAA,CAAc,GAAG,CAAG,EAAA;AACtB,IAAO,OAAA,GAAA,CAAA;AAAA,GACT;AACA,EAAA,OAAO,MAAO,CAAA,MAAA,CAAO,EAAC,EAAG,GAAG,CAAA,CAAA;AAC9B,CAR6B,EAAA,sBAAA,CAAA,CAAA;AAU7B,IAAM,oBAAA,2BAAwB,IAAmC,KAAA;AAC/D,EAAM,MAAA,OAAA,GAAU,CAAC,OAAA,EAAS,SAAS,CAAA,CAAA;AAEnC,EAAA,OAAO,OAAO,IAAK,CAAA,IAAI,CACpB,CAAA,MAAA,CAAO,CAAC,GAAQ,KAAA,CAAC,OAAQ,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA,CACtC,MAAoB,CAAA,CAAC,OAAO,GAAQ,KAAA;AACnC,IAAM,MAAA,KAAA,GAAQ,KAAK,GAAG,CAAA,CAAA;AACtB,IAAM,KAAA,CAAA,GAAG,CAAI,GAAA,oBAAA,CAAqB,KAAK,CAAA,CAAA;AACvC,IAAO,OAAA,KAAA,CAAA;AAAA,GACT,EAAG,EAAE,CAAA,CAAA;AACT,CAV6B,EAAA,sBAAA,CAAA,CAAA;AAY7B,IAAM,yBAAA,2BAA6B,SAAkC,KAAA;AACnE,EAAA,MAAM,UAA0B,GAAA;AAAA,IAC9B,SAAS,SAAU,CAAA,OAAA;AAAA,GACrB,CAAA;AACA,EAAA,KAAA,MAAW,CAAC,GAAK,EAAA,KAAK,KAAK,MAAO,CAAA,OAAA,CAAQ,SAAS,CAAG,EAAA;AACpD,IAAI,IAAA,GAAA,KAAQ,WAAW,MAAO,CAAA,SAAA,CAAU,eAAe,IAAK,CAAA,SAAA,EAAW,GAAG,CAAG,EAAA;AAC3E,MAAW,UAAA,CAAA,GAAG,CAAI,GAAA,oBAAA,CAAqB,KAAK,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF;AACA,EAAO,OAAA,UAAA,CAAA;AACT,CAVkC,EAAA,2BAAA,CAAA,CAAA;AAmBrB,IAAA,8BAAA,GAAN,cAA6C,eAAgB,CAAA;AAAA,EA1FpE;AA0FoE,IAAA,MAAA,CAAA,IAAA,EAAA,gCAAA,CAAA,CAAA;AAAA,GAAA;AAAA,EAClD,MAAA,CAAA;AAAA,EACT,sBAAA,CAAA;AAAA,EACE,IAAA,CAAA;AAAA,EAET,YAAY,OAAgD,EAAA;AAC1D,IAAM,KAAA,CAAA,EAAE,OAAO,OAAQ,CAAA,KAAA,IAAS,QAAQ,MAAQ,EAAA,OAAA,CAAQ,MAAU,IAAA,KAAA,EAAO,CAAA,CAAA;AACzE,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,IAAO,GAAA,2BAAA,CAAA;AACZ,IAAK,IAAA,CAAA,sBAAA,GAAyB,QAAQ,sBAA0B,IAAA,IAAA,CAAA;AAAA,GAClE;AAAA,EAEQ,WAAY,CAAA,QAAA,EAAyB,IAAmB,EAAA,OAAA,EAA6B,OAA4B,EAAA;AACvH,IAAM,MAAA,UAAA,GAAa,qBAAqB,IAAI,CAAA,CAAA;AAC5C,IAAI,IAAA,QAAA,CAAA;AAEJ,IAAI,IAAA,WAAA,CAAY,IAAI,CAAG,EAAA;AACrB,MAAW,QAAA,GAAA,IAAA,CAAA;AAAA,KACb,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAW,QAAA,GAAA,OAAA,CAAA;AAAA,KACb,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAW,QAAA,GAAA,OAAA,CAAA;AAAA,KACb;AAEA,IAAA,IAAI,QAAU,EAAA;AACZ,MAAA,MAAA,CAAO,MAAO,CAAA,UAAA,EAAY,yBAA0B,CAAA,QAAQ,CAAC,CAAA,CAAA;AAAA,KAC/D;AAEA,IAAA,IAAI,YAAY,QAAU,EAAA;AACxB,MAAO,MAAA,CAAA,MAAA,CAAO,YAAY,OAAO,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,IAAA,CAAK,OAAO,UAAW,CAAA;AAAA,MACrB,OAAA,EAAS,OAAO,OAAO,CAAA;AAAA,MACvB,QAAA,EAAU,oBAAoB,QAAQ,CAAA;AAAA,MACtC,UAAY,EAAA,UAAA;AAAA,KACb,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,eAAA,CAAgB,IAAmB,EAAA,OAAA,EAA6B,OAA4B,EAAA;AAClG,IAAA,MAAM,iBAA8B,EAAC,CAAA;AACrC,IAAI,IAAA,SAAA,CAAA;AAEJ,IAAI,IAAA,WAAA,CAAY,IAAI,CAAG,EAAA;AACrB,MAAY,SAAA,GAAA,IAAA,CAAA;AAAA,KACd,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAY,SAAA,GAAA,OAAA,CAAA;AAAA,KACd,MAAA,IAAW,WAAY,CAAA,OAAO,CAAG,EAAA;AAC/B,MAAY,SAAA,GAAA,OAAA,CAAA;AAAA,KACP,MAAA;AACL,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,IAAI,OAAO,OAAA,KAAY,QAAY,IAAA,SAAA,CAAU,YAAY,OAAS,EAAA;AAChE,MAAA,cAAA,CAAe,OAAU,GAAA,OAAA,CAAA;AAAA,KAC3B;AAEA,IAAA,IAAI,cAAc,OAAS,EAAA;AACzB,MAAO,MAAA,CAAA,MAAA,CAAO,gBAAgB,OAAO,CAAA,CAAA;AAAA,KACvC;AAEA,IAAA,IAAA,CAAK,OAAO,cAAe,CAAA,EAAE,SAAW,EAAA,UAAA,EAAY,gBAAgB,CAAA,CAAA;AAAA,GACtE;AAAA,EAES,GAAA,CAAI,MAAmB,QAA4B,EAAA;AAC1D,IAAM,MAAA,EAAE,KAAO,EAAA,OAAA,EAAY,GAAA,IAAA,CAAA;AAC3B,IAAM,MAAA,QAAA,GAAW,gBAAgB,KAAK,CAAA,CAAA;AACtC,IAAM,MAAA,KAAA,GAAQ,QAAQ,GAAI,CAAA,IAAA,EAAM,OAAO,GAAI,CAAA,OAAO,CAAC,CAAA,IAAK,EAAC,CAAA;AACzD,IAAA,MAAM,UAAU,KAAM,CAAA,MAAA,GAAS,KAAM,CAAA,CAAC,IAAI,EAAC,CAAA;AAE3C,IAAA,IAAA,CAAK,WAAY,CAAA,QAAA,EAAU,IAAM,EAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAEjD,IAAI,IAAA,IAAA,CAAK,sBAA0B,IAAA,QAAA,IAAY,CAAqB,cAAA;AAClE,MAAK,IAAA,CAAA,eAAA,CAAgB,IAAM,EAAA,OAAA,EAAS,OAAO,CAAA,CAAA;AAAA,KAC7C;AAEA,IAAS,QAAA,EAAA,CAAA;AAAA,GACX;AACF","file":"index.mjs","sourcesContent":["import { TelemetryClient, KnownSeverityLevel } from 'applicationinsights';\nimport TransportStream from 'winston-transport';\n\ntype PlainObject = Record<string, any>;\n\nenum SeverityLevel {\n  Verbose = 0,\n  Information = 1,\n  Warning = 2,\n  Error = 3,\n  Critical = 4,\n}\n\nconst knownSeverityLevels: Record<SeverityLevel, KnownSeverityLevel> = {\n  [SeverityLevel.Verbose]: KnownSeverityLevel.Verbose,\n  [SeverityLevel.Information]: KnownSeverityLevel.Information,\n  [SeverityLevel.Warning]: KnownSeverityLevel.Warning,\n  [SeverityLevel.Error]: KnownSeverityLevel.Error,\n  [SeverityLevel.Critical]: KnownSeverityLevel.Critical,\n};\n\n\nconst getMessageLevel = (winstonLevel: string): SeverityLevel => {\n  const levels: Record<string, SeverityLevel> = {\n    emerg: SeverityLevel.Critical,\n    alert: SeverityLevel.Critical,\n    crit: SeverityLevel.Critical,\n    error: SeverityLevel.Error,\n    warning: SeverityLevel.Warning,\n    warn: SeverityLevel.Warning,\n    notice: SeverityLevel.Information,\n    info: SeverityLevel.Information,\n    verbose: SeverityLevel.Verbose,\n    debug: SeverityLevel.Verbose,\n    silly: SeverityLevel.Verbose,\n  } as const;\n\n  return levels[winstonLevel] ?? SeverityLevel.Information;\n};\n\nconst isErrorLike = (obj: unknown): obj is Error => {\n  return obj instanceof Error;\n};\n\n\nconst isPlainObject = (obj: unknown): obj is PlainObject => {\n  return obj !== null && typeof obj === 'object' && Object.getPrototypeOf(obj) === Object.prototype;\n};\n\nconst convertToPlainObject = (obj: any): PlainObject => {\n  if (typeof obj !== 'object') {\n    return obj;\n  }\n  if (isPlainObject(obj)) {\n    return obj;\n  }\n  return Object.assign({}, obj);\n};\n\nconst extractPropsFromInfo = (info: PlainObject): PlainObject => {\n  const exclude = ['level', 'message'];\n\n  return Object.keys(info)\n    .filter((key) => !exclude.includes(key))\n    .reduce<PlainObject>((props, key) => {\n      const value = info[key];\n      props[key] = convertToPlainObject(value);\n      return props;\n    }, {});\n};\n\nconst extractErrorPropsForTrace = (errorLike: Error): PlainObject => {\n  const properties: PlainObject = {\n    message: errorLike.message,\n  };\n  for (const [key, value] of Object.entries(errorLike)) {\n    if (key !== 'stack' && Object.prototype.hasOwnProperty.call(errorLike, key)) {\n      properties[key] = convertToPlainObject(value);\n    }\n  }\n  return properties;\n};\n\nexport interface AzureApplicationInsightsLoggerOptions {\n  client: TelemetryClient;\n  level?: string;\n  silent?: boolean;\n  sendErrorsAsExceptions?: boolean;\n}\n\nexport class AzureApplicationInsightsLogger extends TransportStream {\n  public readonly client: TelemetryClient;\n  public sendErrorsAsExceptions: boolean;\n  readonly name: string;\n\n  constructor(options: AzureApplicationInsightsLoggerOptions) {\n    super({ level: options.level ?? 'info', silent: options.silent ?? false });\n    this.client = options.client;\n    this.name = 'applicationinsightslogger';\n    this.sendErrorsAsExceptions = options.sendErrorsAsExceptions ?? true;\n  }\n\n  private handleTrace(severity: SeverityLevel, info: PlainObject, message: string | undefined, logMeta: PlainObject): void {\n    const traceProps = extractPropsFromInfo(info);\n    let errorArg: Error | undefined;\n\n    if (isErrorLike(info)) {\n      errorArg = info;\n    } else if (isErrorLike(message)) {\n      errorArg = message as unknown as Error;\n    } else if (isErrorLike(logMeta)) {\n      errorArg = logMeta;\n    }\n\n    if (errorArg) {\n      Object.assign(traceProps, extractErrorPropsForTrace(errorArg));\n    }\n\n    if (logMeta !== errorArg) {\n      Object.assign(traceProps, logMeta);\n    }\n\n    this.client.trackTrace({\n      message: String(message),\n      severity: knownSeverityLevels[severity],\n      properties: traceProps,\n    });\n  }\n\n  private handleException(info: PlainObject, message: string | undefined, logMeta: PlainObject): void {\n    const exceptionProps: PlainObject = {};\n    let exception: Error | undefined;\n\n    if (isErrorLike(info)) {\n      exception = info;\n    } else if (isErrorLike(message)) {\n      exception = message as unknown as Error;\n    } else if (isErrorLike(logMeta)) {\n      exception = logMeta;\n    } else {\n      return;\n    }\n\n    if (typeof message === 'string' && exception.message !== message) {\n      exceptionProps.message = message;\n    }\n\n    if (exception !== logMeta) {\n      Object.assign(exceptionProps, logMeta);\n    }\n\n    this.client.trackException({ exception, properties: exceptionProps });\n  }\n\n  override log(info: PlainObject, callback: () => void): void {\n    const { level, message } = info;\n    const severity = getMessageLevel(level);\n    const splat = Reflect.get(info, Symbol.for('splat')) ?? [];\n    const logMeta = splat.length ? splat[0] : {};\n\n    this.handleTrace(severity, info, message, logMeta);\n\n    if (this.sendErrorsAsExceptions && severity >= SeverityLevel.Error) {\n      this.handleException(info, message, logMeta);\n    }\n\n    callback();\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@shellicar/winston-azure-application-insights",
+  "version": "5.0.0",
+  "private": false,
+  "description": "Azure Application Insights transport for Winston",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "require": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs"
+    },
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/willmorgan/winston-azure-application-insights.git"
+  },
+  "keywords": [
+    "winston",
+    "azure",
+    "insights",
+    "logging"
+  ],
+  "author": "Marco Braga (Bragma)",
+  "contributors": [
+    {
+      "name": "Will Morgan",
+      "email": "jobs+npm@willmorgan.co.uk",
+      "url": "http://willmorgan.co.uk"
+    },
+    {
+      "name": "Stephen Hellicar",
+      "email": "shellicar@gmail.com"
+    }
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/mocha": "^10.0.8",
+    "@types/node": "^22.5.5",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
+    "eslint": "^9.11.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "globals": "^15.9.0",
+    "mocha": "^10.7.3",
+    "npm-run-all2": "^6.2.3",
+    "terser": "^5.33.0",
+    "testdouble": "^3.20.2",
+    "tsup": "^8.3.0",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.2",
+    "winston": "^3.14.2"
+  },
+  "bugs": {
+    "url": "https://github.com/shellicar/winston-azure-application-insights/issues"
+  },
+  "homepage": "https://github.com/shellicar/winston-azure-application-insights#readme",
+  "dependencies": {
+    "applicationinsights": "^3.3.0",
+    "winston-transport": "^4.7.1"
+  },
+  "scripts": {
+    "demo": "tsx demo.ts",
+    "build": "run-s build:source build:types",
+    "build:source": "tsup",
+    "build:types": "tsup --dts-only --format cjs",
+    "lint": "eslint .",
+    "lint-fix": "eslint . --fix",
+    "test": "mocha"
+  }
+}