logentryfingerprint

Documentation

Overview

Copyright 2023 Meta Platforms, Inc. and affiliates.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Index

• Constants
• type FieldValue
• type PreHook
  • func (PreHook) ProcessInput(_ belt.TraceIDs, level logger.Level, args ...any) types.PreHookResult
  • func (PreHook) ProcessInputFields(_ belt.TraceIDs, level logger.Level, message string, ...) types.PreHookResult
  • func (PreHook) ProcessInputf(_ belt.TraceIDs, level logger.Level, format string, _ ...any) types.PreHookResult

Constants

const (
	// FieldKey is the key value of field, which contains
	// the log entry signature/fingerprint (see also FieldValue).
	FieldKey = "immune/logentryfingerprint"
)

Types

type FieldValue

type FieldValue string

FieldValue is the custom type for a field, which contains the resulting signature/fingerprint.

type PreHook

type PreHook struct{}

PreHook generates so-so stable unique signatures/fingerprint (basically just hashes) for each place where we issue logs through a Logger.

The term "signature" here is not in cryptographic meaning, but in algorithmic: https://en.wikipedia.org/wiki/Signature_(logic)

This is a semantic analogy of the default implementation of a fingerprint like in Sentry:

https://docs.sentry.io/product/sentry-basics/grouping-and-fingerprints/

The parts expected to be variable are ignored, such as TraceIDs and format arguments.

It could be used to automatically categorize errors, for example.

To override the algorithm of the fingerprint, just set another hook.

func (PreHook) ProcessInput

func (PreHook) ProcessInput(_ belt.TraceIDs, level logger.Level, args ...any) types.PreHookResult

ProcessInput implements logger.PreHook (see the description of the `PreHook` structure)

func (PreHook) ProcessInputFields

func (PreHook) ProcessInputFields(_ belt.TraceIDs, level logger.Level, message string, fields field.AbstractFields) types.PreHookResult

ProcessInputFields implements logger.PreHook (see the description of the `PreHook` structure)

func (PreHook) ProcessInputf

func (PreHook) ProcessInputf(_ belt.TraceIDs, level logger.Level, format string, _ ...any) types.PreHookResult

ProcessInputf implements logger.PreHook (see the description of the `PreHook` structure)