CodeGuard

Logs sammeln

Welche Logs ihr bei einem Problem mitschickt damit wir schnell helfen können.

Aktualisiert am 2026-05-28

Logs sammeln

Wenn ihr ein Problem mit CodeGuard habt, helfen uns die richtigen Logs um die Diagnose abzukürzen.

CLI-Verbose-Log

Der wichtigste Datenpunkt. Lauft das Problem mit --verbose:

codeguard analyze . --verbose 2> codeguard.log

In codeguard.log steht:

  • Welche Konfig geladen wurde
  • Welche Regeln aktiv sind
  • Welche Solution-Projekte gefunden wurden
  • Welche Cache-Hits passieren
  • Stack-Traces wenn etwas crasht

Häng die Datei an, wenn ihr uns schreibt.

VS-Code-Extension-Log

View → Output, im Dropdown "CodeGuard" auswählen, Inhalt kopieren.

Falls die Extension während des Logs noch lief, ist das Log live - einmal "Analyze again" anstoßen, dann Inhalt kopieren.

CI-Logs

Bei einem CI-Problem:

  • GitHub Actions: den Workflow-Run anklicken, "View raw logs" klicken, Inhalt als .txt speichern.
  • GitLab: Job-Detail-Seite, "Show complete raw" oben rechts.
  • TeamCity: Build-Detail, "Build Log" Tab, "Download".
  • Andere: äquivalent.

Bei großen Logs reicht oft ein Schnitt um die relevante Stelle plus 20 Zeilen drumherum.

CLI-Version und System-Info

codeguard --version
dotnet --info
uname -a              # Linux / macOS
systeminfo            # Windows

Schickt das auch mit. Hilft uns Plattform-spezifische Probleme einzugrenzen.

Solution-Info ohne sensitive Daten

# Zählt Projekte ohne Pfade preiszugeben
find . -name "*.csproj" | wc -l

Wenn ihr eine konkrete Datei meint, könnt ihr eine minimale Repro extrahieren, die kleinste Code-Stelle die das Problem zeigt:

// minimal-repro.cs
using System;

public class Example
{
    public void Demo()
    {
        // Hier passiert das Problem
    }
}

Eine Solution mit einem Projekt mit dieser Datei reicht uns. Wir brauchen nicht eure echte Codebasis.

Networking-Logs

Wenn ihr Probleme mit dem CLI-Download habt:

curl -v -H "Authorization: Bearer $CODEGUARD_API_KEY" \
    https://codeguard.bochmann-software.com/api/v1/cli/latest/linux-x64 \
    -o codeguard.zip 2> network.log

-v macht den vollen HTTP-Trace. Header-Felder enthalten keine Klartexte des API-Keys (er steht nur einmal im Authorization-Header, den könnt ihr durch Authorization: Bearer *** ersetzen).

Portal-seitige Logs

Wenn das Problem im Portal ist (Login geht nicht, Download bricht ab), können wir auf Anfrage nachschlagen, ob bei uns ein Fehler aufgetreten ist. Schickt uns:

  • Die ungefähre Zeit (UTC)
  • Die Email mit der ihr eingeloggt wart
  • Den Browser-Stack (Chrome 121, Firefox 122, ...)

Was wir NICHT brauchen

  • Eure komplette Codebasis (auch nicht im NDA-Modus, wir wollen sie schlicht nicht).
  • Klartext-API-Keys. Wenn ein Log einen Key zeigt, masked ihn.
  • Klartext-Passwörter. Wir bekommen sowieso nur Hashes zu sehen, ihr schickt sie nicht aus.

Wie ihr das alles verschickt

Email an [email protected] mit Logs als .txt- oder .log-Anhänge. Wenn die Files groß sind (mehrere MB), gerne als gzip oder zip.

Wir antworten in der Regel innerhalb von 24 Stunden an Werktagen.