开源项目 `plug_logger_json` 使用教程

开源项目 plug_logger_json 使用教程

plug_logger_jsonElixir Plug that formats http request logs as json项目地址:https://gitcode.com/gh_mirrors/pl/plug_logger_json

1. 项目的目录结构及介绍

plug_logger_json 是一个用于格式化 HTTP 请求日志的 Elixir 插件。以下是该项目的目录结构及其介绍：

plug_logger_json/
├── config/         # 配置文件目录
│   ├── config.exs  # 主配置文件
│   └── ...         # 其他环境配置文件
├── lib/            # 源代码目录
│   ├── plug/       # Plug 相关代码
│   └── ...         # 其他模块代码
├── test/           # 测试代码目录
│   ├── test_helper.exs
│   └── ...         # 其他测试文件
├── .formatter.exs  # 代码格式化配置
├── .gitignore      # Git 忽略文件配置
├── CHANGELOG.md    # 更新日志
├── LICENSE         # 许可证文件
├── README.md       # 项目说明文档
├── mix.exs         # 项目配置文件
└── mix.lock        # 依赖锁定文件

目录结构介绍

• config/：包含项目的配置文件，如 config.exs 用于定义项目的基本配置。
• lib/：包含项目的源代码，其中 plug/ 目录下是与 Plug 相关的代码。
• test/：包含项目的测试代码，用于确保代码的正确性。
• .formatter.exs：用于配置代码格式化的规则。
• .gitignore：定义了 Git 版本控制系统中需要忽略的文件和目录。
• CHANGELOG.md：记录项目的更新日志，方便用户了解项目的变更历史。
• LICENSE：项目的许可证文件，说明项目的使用条款。
• README.md：项目的说明文档，包含项目的基本信息和使用方法。
• mix.exs：项目的配置文件，定义了项目的依赖、版本等信息。
• mix.lock：锁定项目的依赖版本，确保项目在不同环境中的一致性。

2. 项目的启动文件介绍

plug_logger_json 项目的启动文件主要是 mix.exs 和 config/config.exs。

mix.exs

mix.exs 文件是 Elixir 项目的配置文件，定义了项目的依赖、版本、应用程序等信息。以下是该文件的主要内容：

defmodule PlugLoggerJson.MixProject do
  use Mix.Project

  def project do
    [
      app: :plug_logger_json,
      version: "0.7.0",
      elixir: "~> 1.0",
      start_permanent: Mix.env() == :prod,
      deps: deps()
    ]
  end

  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      {:plug, "~> 1.0"},
      {:poison, "~> 1.5 or ~> 2.0 or ~> 3.0 or ~> 4.0"}
    ]
  end
end

config/config.exs

config/config.exs 文件是项目的配置文件，用于定义项目的各种配置选项。以下是该文件的主要内容：

import Config

config :plug_logger_json,
  filtered_keys: ["password", "authorization"],
  suppressed_keys: ["api_version", "log_type"]

3. 项目的配置文件介绍

plug_logger_json 项目的配置文件主要位于 config/ 目录下，包括 config.exs 和其他环境特定的配置文件。

config.exs

config.exs 文件是项目的主配置文件，定义了项目的各种配置选项，如过滤和抑制的日志键。以下是该文件的主要内容：

import Config

config :plug_logger_json,
  filtered_keys: ["password", "authorization"],
  suppressed_keys: ["api_version", "log_type"]

其他环境配置文件

除了 config.exs 文件外，项目还可能包含其他环境特定的配置文件，如 config/dev.exs、config/test.exs 和 `

plug_logger_jsonElixir Plug that formats http request logs as json项目地址:https://gitcode.com/gh_mirrors/pl/plug_logger_json