@miketako3/cloki 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MikeTako
+
+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,40 @@
+# Cloki - Simple Logging from Cloudflare Workers to Grafana Cloud's Loki
+
+## Introduction
+
+Welcome to **Cloki**, an open-source logger designed to bridge Cloudflare Workers with Grafana Cloud's Loki seamlessly and efficiently. Targeted at individual developers, Cloki aims to reduce maintenance costs while offering a straightforward logging solution. With minimal configuration and the sole use of the fetch API, Cloki is an easy-to-implement tool for effective logging.
+
+## Features
+
+- **Easy Integration**: Connect Cloudflare Workers with Grafana Cloud's Loki effortlessly.
+- **Minimal Configuration**: Get started with just a few simple settings.
+- **Cost-Effective**: Designed for developers looking to minimize overhead costs.
+- **Pure Fetch API Usage**: No complex dependencies or setups, just the fetch API.
+
+## Getting Started
+
+TBD
+
+## Usage
+
+TBD
+
+## Contributing
+
+Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
+
+- Fork the Project
+- Create your Feature Branch (git checkout -b feature/AmazingFeature)
+- Commit your Changes (git commit -m 'Add some AmazingFeature')
+- Push to the Branch (git push origin feature/AmazingFeature)
+- Open a Pull Request
+
+## License
+
+Distributed under the MIT License. See **LICENSE** for more information.
+
+## Contacts
+
+miketako3 (Kaito Hiruta) - contact@miketako.xyz
+
+Project Link: https://github.com/miketako3/cloki

package/biome.json

@@ -0,0 +1,15 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.5.2/schema.json",
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"files": {
+		"ignore": ["dist/*.js", "dist/*.d.ts", "dist/*.d.ts.map", "dist/*.js.map"]
+	}
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@miketako3/cloki",
+  "version": "0.1.0",
+  "description": "cloki is logger library for Loki and Cloudflare Workers.",
+  "main": "index.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "format": "npx @biomejs/biome format . --write",
+    "lint": "npx @biomejs/biome lint .",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/miketako3/cloki.git"
+  },
+  "keywords": [
+    "cloudflare",
+    "workers",
+    "loki",
+    "grafana",
+    "logger",
+    "logging"
+  ],
+  "author": "miketako3 (Kaito Hiruta)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/miketako3/cloki/issues"
+  },
+  "homepage": "https://github.com/miketako3/cloki#readme",
+  "devDependencies": {
+    "@biomejs/biome": "1.5.2",
+    "@types/node": "^20.11.5",
+    "typescript": "^5.3.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+import { getLokiLogger } from "./logger";

package/src/logger.ts

@@ -0,0 +1,160 @@
+/**
+ * Loki config
+ */
+type LokiConfig = {
+	lokiHost: string;
+	lokiToken: string;
+	lokiUser: string;
+};
+
+/**
+ * Loki labels
+ */
+type LokiLabels = {
+	[key: string]: string;
+};
+
+/**
+ * Loki message
+ */
+type LokiMessage = {
+	streams: [
+		{
+			stream: LokiLabels;
+			values: [string[]];
+		},
+	];
+};
+
+/**
+ * Create a Loki logger
+ * logger has some async logging methods like info, error, warn, etc.
+ *
+ * @param config
+ */
+export const getLokiLogger = (
+	config: LokiConfig,
+): {
+	info: (message: object) => Promise<void>;
+	warn: (message: object) => Promise<void>;
+	error: (message: object) => Promise<void>;
+	debug: (message: object) => Promise<void>;
+} => {
+	return {
+		info: lokiInfo(config),
+		warn: lokiWarn(config),
+		error: lokiError(config),
+		debug: lokiDebug(config),
+	};
+};
+
+/**
+ * Log info to Loki curried
+ *
+ * @param config
+ */
+const lokiInfo =
+	(config: LokiConfig) =>
+	async (message: object, labels: LokiLabels = {}) => {
+		await log(config, "info", message, labels);
+	};
+
+/**
+ * Log warn to Loki curried
+ *
+ * @param config
+ */
+const lokiWarn =
+	(config: LokiConfig) =>
+	async (message: object, labels: LokiLabels = {}) => {
+		await log(config, "warn", message, labels);
+	};
+
+/**
+ * Log error to Loki curried
+ *
+ * @param config
+ */
+const lokiError =
+	(config: LokiConfig) =>
+	async (message: object, labels: LokiLabels = {}) => {
+		await log(config, "error", message, labels);
+	};
+
+/**
+ * Log debug to Loki curried
+ *
+ * @param config
+ */
+const lokiDebug =
+	(config: LokiConfig) =>
+	async (message: object, labels: LokiLabels = {}) => {
+		await log(config, "debug", message, labels);
+	};
+
+/**
+ * Log to Loki
+ *
+ * @param config
+ * @param logLevel
+ * @param message
+ * @param labels
+ */
+async function log(
+	config: LokiConfig,
+	logLevel: string,
+	message: object,
+	labels: LokiLabels,
+) {
+	console.log(message);
+	const lokiMessage = generateLokiMessage(logLevel, message, labels);
+	await sendToLoki(config, lokiMessage);
+}
+
+/**
+ * Generate a Loki message object
+ *
+ * @param logLevel
+ * @param message
+ * @param labels
+ */
+function generateLokiMessage(
+	logLevel: string,
+	message: object,
+	labels: LokiLabels,
+): LokiMessage {
+	return {
+		streams: [
+			{
+				stream: {
+					level: logLevel,
+					...labels,
+				},
+				values: [[`${Date.now().toString()}000000`, message.toString()]],
+			},
+		],
+	};
+}
+
+/**
+ * Send a message to Loki
+ *
+ * @param config
+ * @param lokiMessage
+ */
+async function sendToLoki(config: LokiConfig, lokiMessage: LokiMessage) {
+	try {
+		await fetch(
+			`https://${config.lokiUser}:${config.lokiToken}@${config.lokiHost}/loki/api/v1/push`,
+			{
+				method: "POST",
+				headers: {
+					"Content-Type": "application/json",
+				},
+				body: JSON.stringify(lokiMessage),
+			},
+		);
+	} catch (e) {
+		console.log("Send message to Loki was failed. : {}", e);
+	}
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*.ts"]
+}