@monocle.sh/effect-agent 0.0.1 → 0.1.0

package/LICENSE.md

@@ -0,0 +1,53 @@
+## Elastic License 2.0 (ELv2)
+
+### Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+### Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+### Limitations
+
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor's trademarks is subject to applicable law.
+
+### Patents
+
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+### Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+### No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+### Termination
+
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+### No Liability
+
+_As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim._
+
+### Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the software the licensor makes available under these terms, including any portion of it.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.
+
+**Trademark** means trademarks, service marks, and similar rights.

package/dist/_virtual/_rolldown/runtime.mjs

@@ -0,0 +1,13 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+export { __exportAll };

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { MonocleEffectConfig } from "./src/types.mjs";
+import { MonocleEffectConfig, MonocleUser } from "./src/types.mjs";
 import { MonocleLayer } from "./src/layer.mjs";
+import { monocle_d_exports } from "./src/monocle.mjs";
 import { MonocleSpanProcessor } from "./src/index.mjs";
-export { MonocleEffectConfig, MonocleLayer, MonocleSpanProcessor };
+export { monocle_d_exports as Monocle, MonocleEffectConfig, MonocleLayer, MonocleSpanProcessor, MonocleUser };

package/dist/index.mjs

@@ -1,3 +1,4 @@
 import { MonocleLayer } from "./src/layer.mjs";
+import { monocle_exports } from "./src/monocle.mjs";
 import { MonocleSpanProcessor } from "./src/index.mjs";
-export { MonocleLayer, MonocleSpanProcessor };
+export { monocle_exports as Monocle, MonocleLayer, MonocleSpanProcessor };

package/dist/src/index.d.mts

@@ -1,4 +1,5 @@
-import { MonocleEffectConfig } from "./types.mjs";
+import { MonocleEffectConfig, MonocleUser } from "./types.mjs";
 import { MonocleLayer } from "./layer.mjs";
+import { monocle_d_exports } from "./monocle.mjs";
 import { MonocleSpanProcessor as MonocleSpanProcessor$1 } from "@monocle.sh/otel-utils";
 export { MonocleSpanProcessor$1 as MonocleSpanProcessor };

package/dist/src/index.mjs

@@ -1,3 +1,4 @@
 import "./layer.mjs";
+import "./monocle.mjs";
 import { MonocleSpanProcessor as MonocleSpanProcessor$1 } from "@monocle.sh/otel-utils";
 export { MonocleSpanProcessor$1 as MonocleSpanProcessor };

package/dist/src/layer.mjs

@@ -20,6 +20,18 @@ const DEV_BATCH_CONFIG = {
 	...DEFAULT_BATCH_CONFIG,
 	scheduledDelayMillis: 100
 };
+function resolveSdkVersion() {
+	return "0.1.0";
+}
+function buildNodejsResourceAttributes() {
+	const attributes = {
+		"monocle.language.name": "javascript",
+		"monocle.framework.name": "effect"
+	};
+	const sdkVersion = resolveSdkVersion();
+	if (sdkVersion) attributes["telemetry.sdk.version"] = sdkVersion;
+	return attributes;
+}
 /**
 * Resolve the Monocle API key from config or MONOCLE_API_KEY env var.
 * Returns a Redacted value to prevent accidental logging.
@@ -53,6 +65,10 @@ function MonocleLayer(config) {
 	const endpoint = isDev ? config.endpoint || DEV_ENDPOINT : config.endpoint || DEFAULT_ENDPOINT;
 	const environment = resolveEnvironment(config.environment);
 	const batchConfig = isDev ? DEV_BATCH_CONFIG : DEFAULT_BATCH_CONFIG;
+	const resourceAttributes = {
+		"deployment.environment": environment,
+		...buildNodejsResourceAttributes()
+	};
 	const headers = { "x-monocle-env": environment };
 	if (Option.isSome(apiKey)) headers["x-api-key"] = Redacted.value(apiKey.value);
 	const monocleProcessor = new MonocleSpanProcessor();
@@ -60,7 +76,7 @@ function MonocleLayer(config) {
 		resource: {
 			serviceName: config.serviceName,
 			serviceVersion: config.serviceVersion ?? "0.0.0",
-			attributes: { "deployment.environment": environment }
+			attributes: resourceAttributes
 		},
 		spanProcessor: [monocleProcessor, new BatchSpanProcessor(new OTLPTraceExporter({
 			url: `${endpoint}/v1/traces`,

package/dist/src/monocle.d.mts

@@ -0,0 +1,17 @@
+import { MonocleUser } from "./types.mjs";
+import * as Effect from "effect/Effect";
+
+//#region src/monocle.d.ts
+declare namespace monocle_d_exports {
+  export { setUser };
+}
+/**
+ * Set user information on the current active span.
+ * `name` is displayed with priority over `email` in the Monocle UI.
+ * Falls back to `email`, then `id`.
+ *
+ * No-ops when there is no active span.
+ */
+declare const setUser: (user: MonocleUser) => Effect.Effect<void>;
+//#endregion
+export { monocle_d_exports };

package/dist/src/monocle.mjs

@@ -0,0 +1,23 @@
+import { __exportAll } from "../_virtual/_rolldown/runtime.mjs";
+import * as Effect from "effect/Effect";
+//#region src/monocle.ts
+var monocle_exports = /* @__PURE__ */ __exportAll({ setUser: () => setUser });
+/**
+* Set user information on the current active span.
+* `name` is displayed with priority over `email` in the Monocle UI.
+* Falls back to `email`, then `id`.
+*
+* No-ops when there is no active span.
+*/
+const setUser = (user) => Effect.currentSpan.pipe(Effect.andThen((span) => {
+	span.attribute("user.id", String(user.id));
+	if (user.email) span.attribute("user.email", user.email);
+	if (user.name) span.attribute("user.name", user.name);
+	for (const [key, value] of Object.entries(user)) {
+		if (key === "id" || key === "email" || key === "name") continue;
+		if (value === void 0) continue;
+		span.attribute(`user.${key}`, value);
+	}
+}), Effect.ignore);
+//#endregion
+export { monocle_exports };

package/dist/src/types.d.mts

@@ -1,4 +1,10 @@
 //#region src/types.d.ts
+interface MonocleUser {
+  id: string | number;
+  email?: string;
+  name?: string;
+  [key: string]: string | number | boolean | string[] | undefined;
+}
 interface MonocleEffectConfig {
   /**
    * Enable local DevTools mode.
@@ -32,4 +38,4 @@ interface MonocleEffectConfig {
   endpoint?: string;
 }
 //#endregion
-export { MonocleEffectConfig };
+export { MonocleEffectConfig, MonocleUser };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monocle.sh/effect-agent",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Monocle observability agent for Effect applications",
   "keywords": [
     "effect",
@@ -9,13 +9,13 @@
     "opentelemetry",
     "tracing"
   ],
-  "homepage": "https://github.com/monocle-sh/monocle/tree/main/packages/effect-agent",
+  "homepage": "https://github.com/monocle-sh/js/tree/main/packages/agents/effect",
   "license": "ISC",
   "author": "Julien Ripouteau <julien@ripouteau.com>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/monocle-sh/monocle.git",
-    "directory": "packages/effect-agent"
+    "url": "git+https://github.com/monocle-sh/js.git",
+    "directory": "packages/agents/effect"
   },
   "files": [
     "dist"
@@ -38,7 +38,7 @@
     "@opentelemetry/sdk-logs": "^0.214.0",
     "@opentelemetry/sdk-metrics": "^2.6.1",
     "@opentelemetry/sdk-trace-node": "^2.6.1",
-    "@monocle.sh/otel-utils": "1.0.1"
+    "@monocle.sh/otel-utils": "1.1.0"
   },
   "devDependencies": {
     "@adonisjs/tsconfig": "^2.0.0",

package/LICENSE

@@ -1,15 +0,0 @@
-ISC License
-
-Copyright (c) 2024-present, Julien Ripouteau
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.