간단한 golang Logrus 사용법 튜토리얼

다음은 golang튜토리얼 칼럼에 실린 간단한 golang Logrus 사용법 튜토리얼입니다. 도움이 필요한 친구들에게 도움이 되길 바랍니다!

golang Logrus 사용하기 쉬운 튜토리얼

Logrus를 사용하는 가장 쉬운 방법:

package main
import (
  log "github.com/sirupsen/logrus"
)
func main() {
  log.WithFields(log.Fields{
    "animal": "walrus",
  }).Info("A walrus appears")
}

stdlib 로거와 완전히 API 호환되므로 로그, 로그 "github.com/ 시럽센/로그루스". 모든 것을 맞춤 설정할 수도 있습니다.

package main
import (
  "os"
  log "github.com/sirupsen/logrus"
)
func init() {
  // Log 为JSON而不是默认的ASCII格式。
  log.SetFormatter(&log.JSONFormatter{})
  // 输出到标准输出，而不是默认的标准错误
  //可以是任何io.Writer，请参阅下面的文件例如日志。
  log.SetOutput(os.Stdout)
  // 仅记录严重警告以上。
  log.SetLevel(log.WarnLevel)
}
func main() {
  log.WithFields(log.Fields{
    "animal": "walrus",
    "size":   10,
  }).Info("A group of walrus emerges from the ocean")
  log.WithFields(log.Fields{
    "omg":    true,
    "number": 122,
  }).Warn("The group's number increased tremendously!")
  log.WithFields(log.Fields{
    "omg":    true,
    "number": 100,
  }).Fatal("The ice breaks!")
  // 一种常见的模式是通过重用
  //从WithFields返回的logrus.Entry 来重用日志记录语句之间的字段
  contextLogger := log.WithFields(log.Fields{
    "common": "this is a common field",
    "other": "I also should be logged always",
  })
  contextLogger.Info("I'll be logged with common and other field")
  contextLogger.Info("Me too")
}

더 고급 사용을 위해 대규모 프로젝트의 경우 프로젝트의 모든 로그를 기록하기 위해 전역 로그러스 인스턴스, 즉 로거 개체가 필요한 경우가 많습니다. 예는 다음과 같습니다:

package main
import (
  "os"
  "github.com/sirupsen/logrus"
)
// 创建记录器的一个新实例。您可以有任意多个实例
var log = logrus.New()
func main() {
  // 用于设置属性的API与程序包级别
  // 导出的记录器有些不同。见Godoc。
  log.Out = os.Stdout
  // 您可以将其设置为任何`io.Writer`
  // file, err := os.OpenFile("logrus.log", os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
  // if err == nil {
  //  log.Out = file
  // } else {
  //  log.Info("Failed to log to file, using default stderr")
  // }
  log.WithFields(logrus.Fields{
    "animal": "walrus",
    "size":   10,
  }).Info("A group of walrus emerges from the ocean")
}

필드:

Logrus는 길고 구문 분석할 수 없는 오류 메시지보다는 로깅 필드를 통해 신중하게 구조화된 로깅을 권장합니다. 예를 들어, log.Fatalf("%s 이벤트를 %d 키를 사용하여 %s 주제로 보내지 못했습니다.") 대신 다음을 사용해야 합니다. 로그 메시지 로깅을 수행합니다. 우리는 이미 존재하는 로그 문에 필드를 추가하는 것만으로도 시간이 절약되는 수많은 상황에 직면했습니다. WithFields 호출은 선택 사항입니다.

일반적으로 Logrus에서 printf 계열 기능을 사용하는 것은 힌트로 간주되어야 하며 필드를 추가해야 하지만 여전히 Logrus에서 printf 계열 기능을 사용할 수 있습니다.

기본 필드

애플리케이션이나 애플리케이션의 일부에 있는 로그 문에 항상 필드를 연결하는 것이 도움이 되는 경우가 많습니다. 예를 들어 요청 컨텍스트에서 항상 request_id 및 user_ip를 기록할 수 있습니다. 모든 줄에 log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})를 작성하는 대신 logrus.Entry 패스를 생성할 수 있습니다:

log.WithFields(log.Fields{
  "event": event,
  "topic": topic,
  "key": key,
}).Fatal("Failed to send event")

Hooks

로깅 수준 후크를 추가할 수 있습니다. . 예를 들어 오류, 치명적 및 패닉 정보에 대한 예외 추적 서비스에 오류를 StatsD로 보내거나 syslog와 같은 여러 위치에 동시에 기록합니다.

Logrus에는 후크가 내장되어 있습니다. 다음 항목 또는 사용자 정의 후크 초기화를 추가하세요.

requestLogger := log.WithFields(log.Fields{"request_id": request_id, "user_ip": user_ip})
requestLogger.Info("something happened on that request") # will log request_id and user_ip
requestLogger.Warn("something not great happened")

참고: Syslog 후크는 로컬 syslog(예: "/dev/log", "/var/run/syslog" 또는 "/var/run/log" ")에 대한 연결도 지원합니다. . 자세한 내용은 syslog 후크 README를 확인하세요.

현재 알려진 서비스 후크 목록은 이 위키 페이지에서 찾을 수 있습니다.

로깅 수준

Logrus에는 추적, 디버그, 정보, 경고, 오류, 위험 및 긴급의 7가지 로깅 수준이 있습니다.

import (
  log "github.com/sirupsen/logrus"
  "gopkg.in/gemnasium/logrus-airbrake-hook.v2" // the package is named "airbrake"
  logrus_syslog "github.com/sirupsen/logrus/hooks/syslog"
  "log/syslog"
)
func init() {
  // Use the Airbrake hook to report errors that have Error severity or above to
  // an exception tracker. You can create custom hooks, see the Hooks section.
  log.AddHook(airbrake.NewHook(123, "xyz", "production"))
  hook, err := logrus_syslog.NewSyslogHook("udp", "localhost:514", syslog.LOG_INFO, "")
  if err != nil {
    log.Error("Unable to connect to local syslog daemon")
  } else {
    log.AddHook(hook)
  }
}

Logger에서 로깅 수준을 설정할 수 있으며 해당 심각도 이상의 항목만 기록합니다.

log.Trace("Something very low level.")
log.Debug("Useful debugging information.")
log.Info("Something noteworthy happened!")
log.Warn("You should probably take a look at this.")
log.Error("Something failed but I'm not quitting.")
// Calls os.Exit(1) after logging
log.Fatal("Bye.")
// Calls panic() after logging
log.Panic("I'm bailing.")

log.Level = logrus.DebugLevel 애플리케이션에 디버그 또는 자세한 환경이 있는 경우 설정하는 것이 유용할 수 있습니다. 거기 위에 있어요.

Entries

추가된 필드 WithField 또는 WithFields 외에도 특정 필드가 모든 로깅 이벤트에 자동으로 추가됩니다:

time. 항목이 생성된 타임스탬프입니다.

msg. {Info, Warn, Error, Fatal, Panic} 호출 후 AddFields에 전달된 로그 메시지입니다. 예를 들어, 이벤트를 보내지 못했습니다.

레벨. 로깅 수준. 예를 들어 정보.

환경

로그러스에는 환경 개념이 없습니다.

특정 환경에서만 후크와 포맷터를 사용하려면 직접 처리해야 합니다. 예를 들어 애플리케이션에 환경의 문자열 표현인 Environment 전역 변수가 있는 경우 다음을 수행할 수 있습니다.

// Will log anything that is info or above (warn, error, fatal, panic). Default.
log.SetLevel(log.InfoLevel)

이 구성은 logrus에서 예상대로 사용되지만 프로덕션의 JSON은 Splunk를 사용할 때만 사용됩니다. 또는 Logstash 및 기타 도구는 로그 집계에만 유용합니다.

Formatter

내장 로그 포맷터는

logrus.TextFormatter입니다. stdout이 tty이면 이벤트가 컬러로 기록되고, 그렇지 않으면 이벤트가 컬러로 기록됩니다.

참고: TTY가 없을 때 강제로 색상을 출력하려면 ForceColors 필드를 true로 설정하세요. TTY를 사용해도 출력을 컬러로 강제하지 않으려면 비활성화Colors 필드를 true로 설정합니다. Windows의 경우 github.com/mattn/go-colorable을 참조하세요.

색상이 활성화되면 레벨은 기본적으로 4자로 잘립니다. 잘림을 비활성화하려면 비활성화레벨 잘림 필드를 true로 설정합니다.

TTY로 출력할 때 모든 레벨의 너비가 동일한 열을 시각적으로 스캔하는 것이 도움이 되는 경우가 많습니다. 레벨 텍스트에 패딩을 추가하고 PadLevelText 필드를 true로 설정하여 이 동작을 활성화합니다.

모든 옵션은 생성된 문서에 나열되어 있습니다.

logrus.JSONFormatter. 필드를 JSON으로 기록합니다.

모든 옵션은 생성된 문서에 나열되어 있습니다.

타사 로그 포맷터:

FluentdFormatter. Kubernetes 및 Google Container Engine에서 파싱할 수 있는 형식 항목입니다.

겔프. Graylog의 GELF 1.1 사양을 준수하도록 항목 형식을 지정합니다.

logstash. 필드를 Logstash 이벤트로 기록합니다.

접두사. 로그 항목 소스와 대체 레이아웃을 표시합니다.

잘고. 잘고의 힘을 불러내세요.

중첩-로그러스-포맷터. 로그 필드를 중첩 구조로 변환합니다.

powerful-logrus-formatter。打印日志时获取文件名，日志行号和最新函数名称；Sava日志到文件。

caption-json-formatter。添加了人类可读标题的logrus消息json格式化程序。

您可以通过实现Formatter接口（需要一种Format方法）来定义格式化程序。Format需要一个*Entry。entry.Data是一种 Fields类型（map[string]interface{}），其中包含您的所有字段以及默认字段（请参见上面的条目部分）：

type MyJSONFormatter struct {
}
log.SetFormatter(new(MyJSONFormatter))
func (f *MyJSONFormatter) Format(entry *Entry) ([]byte, error) {
  // Note this doesn't include Time, Level and Message which are available on
  // the Entry. Consult `godoc` on information about those fields or read the
  // source of the official loggers.
  serialized, err := json.Marshal(entry.Data)
    if err != nil {
      return nil, fmt.Errorf("Failed to marshal fields to JSON, %v", err)
    }
  return append(serialized, '\n'), nil
}

记录为 io.Writer

Logrus可以转换为io.Writer。该作家是an的结尾，io.Pipe您有责任关闭它。

w := logger.Writer()
defer w.Close()
srv := http.Server{
    // create a stdlib log.Logger that writes to
    // logrus.Logger.
    ErrorLog: log.New(w, "", 0),
}

写入该写入器的每一行都将使用格式化程序和钩子以常规方式打印。这些条目的级别为info。

这意味着我们可以轻松覆盖标准库记录器：

logger := logrus.New()
logger.Formatter = &logrus.JSONFormatter{}
// Use logrus for standard log output
// Note that `log` here references stdlib's log
// Not logrus imported under the name `log`.
log.SetOutput(logger.Writer())

日志轮换

Logrus不提供日志轮换。日志轮换应由logrotate(8)可以压缩和删除旧日志条目的外部程序（如）完成。它不应该是应用程序级记录器的功能。

위 내용은 간단한 golang Logrus 사용법 튜토리얼의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!