feat(alexandria): give users and distributors the ability to opt out of alexandria

Signed-off-by: Xe Iaso <me@xeiaso.net>

Author: Xe

.github/copilot-instructions.md

@@ -1,12 +1,16 @@
 # Copilot Instructions
 
-When undertaking a task, take a moment to pause and ask the user what the intent of the task is. Use this to write the best code to fix the problem or implement the feature.
+When undertaking a task, take a moment to pause and ask the user what the intent
+of the task is. Use this to write the best code to fix the problem or implement
+the feature.
 
 ## Code formatting
 
-We always write JavaScript with double quotes and two spaces for indentation, so when your responses include JavaScript code, please follow those conventions.
+We always write JavaScript with double quotes and two spaces for indentation, so
+when your responses include JavaScript code, please follow those conventions.
 
-Go code is written in the style of the standard library. When possible, tests are table-driven tests.
+Go code is written in the style of the standard library. When possible, tests
+are table-driven tests.
 
 All code is formatted with prettier on save, but to run formatting yourself:
 
@@ -16,7 +20,8 @@ npm run format
 
 ## Commit Message Format
 
-Always use conventional commit format for all commit messages. The format should be:
+Always use conventional commit format for all commit messages. The format should
+be:
 
 ```
 <type>[optional scope]: <description>
@@ -31,7 +36,8 @@ Always use conventional commit format for all commit messages. The format should
 - `feat`: A new feature
 - `fix`: A bug fix
 - `docs`: Documentation only changes
-- `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- `style`: Changes that do not affect the meaning of the code (white-space,
+  formatting, missing semi-colons, etc)
 - `refactor`: A code change that neither fixes a bug nor adds a feature
 - `perf`: A code change that improves performance
 - `test`: Adding missing tests or correcting existing tests
@@ -65,15 +71,17 @@ BREAKING CHANGE: User API now requires authentication tokens
 
 ### How to commit
 
-When committing, make sure to use double quotes around your commit message, sign off the commit as:
+When committing, make sure to use double quotes around your commit message, sign
+off the commit as:
 
 ```
 Mimi Yasomi <mimi.yasomi@techaro.lol>
 ```
 
 Make sure Mimi is the author too.
 
-Write your commit to a temporary file before committing. Be sure to use the printf command because you're in fish.
+Write your commit to a temporary file before committing. Be sure to use the
+printf command because you're in fish.
 
 ```
 printf "<type>[optional scope]: <description>\n\n[optional body]\n\nSigned-off-by: Mimi Yasomi <mimi.yasomi@techaro.lol>"

.prettierrc

@@ -3,5 +3,14 @@
   "tabWidth": 2,
   "semi": true,
   "trailingComma": "all",
-  "printWidth": 80
+  "printWidth": 80,
+  "overrides": [
+    {
+      "files": ["*.md"],
+      "options": {
+        "printWidth": 80,
+        "proseWrap": "always"
+      }
+    }
+  ]
 }

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ### Bug Fixes
 
-- **release:** use the god token ([abca8a6](https://github.com/TecharoHQ/alexandria/commit/abca8a66eafba60d9d7f092f9ee9ca1dde76ca7d))
+- **release:** use the god token
+  ([abca8a6](https://github.com/TecharoHQ/alexandria/commit/abca8a66eafba60d9d7f092f9ee9ca1dde76ca7d))
 
 # 1.0.0 (2025-07-28)

CODE_OF_CONDUCT.md

@@ -59,9 +59,8 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
+reported to the community leaders responsible for enforcement at [INSERT CONTACT
+METHOD]. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
@@ -118,8 +117,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.1, available at
 [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
 
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder][Mozilla CoC].
 
 For answers to common questions about this code of conduct, see the FAQ at
 [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at

README.md

@@ -0,0 +1,47 @@
+# Alexandria
+
+As in the library.
+
+This is Techaro's log ingestion and aggregation pipeline, with a client for slog
+to feed logs into the beast.
+
+## Why does this exist?
+
+In order to make sure that Anubis and related infrastructure bits are working
+the best they can, we need to be able to monitor how Anubis is being used in the
+real world. Alexandria is the pipeline that ingests logs from customer instances
+of Anubis, internal infrastructure, and other sources so that there are fewer
+panes of glass to look through when finding information.
+
+Alexandria is the main ingestion component. When Anubis, Thoth, or other
+services emit log lines, they buffer them in-memory for up to 32 kilobytes of
+logs or one minute (whichever happens first). Then the logs are submitted to
+Alexandria, and Alexandria will write them to
+[Tigris](https://www.tigrisdata.com).
+
+Once the logs are written to Tigris, Tigris emits
+[object notification webhooks](https://www.tigrisdata.com/docs/buckets/object-notifications/)
+to serverless functions. These serverless functions will fetch new logs, scrape
+them for relevant information, publish those facts internally, and then handle
+the next log observation.
+
+## How are logs stored?
+
+All logs are stored according to the following lifecycle rules:
+
+- Logs are ingressed into the Standard storage tier into the `logs` folder.
+- One day later, logs are compacted per log ID and moved to the Archive Instant
+  Retrieval storage tier.
+- After 91 days, logs are automatically deleted.
+
+## How do I opt out of this?
+
+For package maintainers, you may opt out of this by building Anubis with the
+`limited-support-ability`
+[build tag](https://www.digitalocean.com/community/tutorials/customizing-go-binaries-with-build-tags).
+Please note that if you do this, Techaro's ability to support your installation
+of Anubis or other software will be limited.
+
+For users, you may opt out of this by running Anubis with the
+`ANUBIS_LOG_SUBMISSION=i-want-to-make-it-harder-to-get-help` envrionment
+variable set.

alexandria/writerwrapper.go

@@ -2,12 +2,6 @@ package alexandria
 
 import (
 	"bytes"
-	"context"
-	"fmt"
-	"io"
-	"log/slog"
-	"net/http"
-	"os"
 	"sync"
 	"time"
 )
@@ -68,101 +62,3 @@ func (rb *ringBuffer) drain() [][]byte {
 
 	return result
 }
-
-func Writer(kind string, logID string, next io.Writer) *WriterWrapper {
-	result := &WriterWrapper{
-		next:    next,
-		baseURL: defaultAlexandriaURL,
-		kind:    kind,
-		logID:   logID,
-		rawLog: slog.New(slog.NewJSONHandler(os.Stderr, &slog.HandlerOptions{
-			AddSource: true,
-		})),
-		rb:   newRingBuffer(),
-		done: make(chan struct{}),
-	}
-
-	result.rawLog.Info("starting up logs to alexandria", "kind", kind, "logID", logID, "target", result.baseURL)
-
-	// Start the background flush goroutine
-	go result.flushLoop()
-
-	return result
-}
-
-type WriterWrapper struct {
-	rb      *ringBuffer
-	next    io.Writer
-	baseURL string
-	kind    string
-	logID   string
-	rawLog  *slog.Logger
-	done    chan struct{}
-}
-
-func (ww *WriterWrapper) SetBaseURL(baseURL string) {
-	ww.baseURL = baseURL
-}
-
-func (ww *WriterWrapper) Write(data []byte) (n int, err error) {
-	ww.rb.add(data)
-	return ww.next.Write(data)
-}
-
-func (ww *WriterWrapper) flushLoop() {
-	ticker := time.NewTicker(flushInterval)
-	defer ticker.Stop()
-
-	for {
-		select {
-		case <-ticker.C:
-			ww.flush()
-		case <-ww.done:
-			// Final flush before exit
-			ww.flush()
-			return
-		}
-	}
-}
-
-func (ww *WriterWrapper) Close() error {
-	close(ww.done)
-	return nil
-}
-
-func (ww *WriterWrapper) flush() {
-	lines := ww.rb.drain()
-	if len(lines) == 0 {
-		return
-	}
-
-	ctx, cancel := context.WithTimeout(context.Background(), flushInterval)
-	defer cancel()
-
-	ww.submit(ctx, lines)
-}
-
-func (ww *WriterWrapper) submit(ctx context.Context, lines [][]byte) {
-	buf := bytes.NewBuffer(nil)
-
-	for _, line := range lines {
-		buf.Write(line)
-	}
-
-	req, err := http.NewRequestWithContext(ctx, http.MethodPut, fmt.Sprintf("%s/upload/%s/%s", ww.baseURL, ww.kind, ww.logID), buf)
-	if err != nil {
-		ww.rawLog.Error("can't create request to alexandria", "err", err)
-		return
-	}
-
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		ww.rawLog.Error("can't perform request to alexandria", "err", err)
-		return
-	}
-
-	if resp.StatusCode != http.StatusOK {
-		ww.rawLog.Error("wrong alexandria response code", "status", resp.StatusCode, "want", http.StatusOK)
-		return
-	}
-}

alexandria/writerwrapper_disabled.go

@@ -0,0 +1,33 @@
+//go:build limitedsupportability
+
+package alexandria
+
+import (
+	"io"
+	"log/slog"
+	"os"
+)
+
+func Writer(kind string, logID string, next io.Writer) *WriterWrapper {
+	result := &WriterWrapper{
+		next: next,
+	}
+
+	lg := slog.New(slog.NewJSONHandler(os.Stderr, &slog.HandlerOptions{
+		AddSource: true,
+	}))
+
+	lg.Info("Logging to Alexandria has been disabled by build tag. Your ability to recieve support is limited.", "docs", "https://anubis.techaro.lol/docs/admin/alexandria")
+
+	return result
+}
+
+type WriterWrapper struct {
+	next io.Writer
+}
+
+func (ww *WriterWrapper) SetBaseURL(baseURL string) {}
+
+func (ww *WriterWrapper) Write(data []byte) (n int, err error) {
+	return ww.next.Write(data)
+}