451.md 37.7 KB
Newer Older
Lab机器人's avatar
readme  
Lab机器人 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
# Log system

> 原文:[https://docs.gitlab.com/ee/administration/logs.html](https://docs.gitlab.com/ee/administration/logs.html)

*   [`production_json.log`](#production_jsonlog)
*   [`production.log`](#productionlog)
*   [`api_json.log`](#api_jsonlog)
*   [`application.log`](#applicationlog)
*   [`application_json.log`](#application_jsonlog)
*   [`integrations_json.log`](#integrations_jsonlog)
*   [`kubernetes.log`](#kuberneteslog)
*   [`git_json.log`](#git_jsonlog)
*   [`audit_json.log`](#audit_jsonlog)
*   [Sidekiq Logs](#sidekiq-logs)
    *   [`sidekiq.log`](#sidekiqlog)
    *   [`sidekiq_client.log`](#sidekiq_clientlog)
*   [`gitlab-shell.log`](#gitlab-shelllog)
    *   [For GitLab versions 12.10 and up](#for-gitlab-versions-1210-and-up)
    *   [For GitLab versions 12.5 through 12.9](#for-gitlab-versions-125-through-129)
    *   [For GitLab 12.5 and earlier](#for-gitlab-125-and-earlier)
*   [Gitaly Logs](#gitaly-logs)
    *   [`grpc.log`](#grpclog)
*   [Puma Logs](#puma-logs)
    *   [`puma_stdout.log`](#puma_stdoutlog)
    *   [`puma_stderr.log`](#puma_stderrlog)
*   [Unicorn Logs](#unicorn-logs)
    *   [`unicorn_stdout.log`](#unicorn_stdoutlog)
    *   [`unicorn_stderr.log`](#unicorn_stderrlog)
*   [`repocheck.log`](#repochecklog)
*   [`importer.log`](#importerlog)
*   [`exporter.log`](#exporterlog)
*   [`auth.log`](#authlog)
*   [`graphql_json.log`](#graphql_jsonlog)
*   [`migrations.log`](#migrationslog)
*   [`mail_room_json.log` (default)](#mail_room_jsonlog-default)
*   [Reconfigure Logs](#reconfigure-logs)
*   [`sidekiq_exporter.log` and `web_exporter.log`](#sidekiq_exporterlog-and-web_exporterlog)
*   [`database_load_balancing.log`](#database_load_balancinglog-premium-only)
*   [`elasticsearch.log`](#elasticsearchlog-starter-only)
*   [`exceptions_json.log`](#exceptions_jsonlog)
*   [`service_measurement.log`](#service_measurementlog)
*   [`geo.log`](#geolog-premium-only)
*   [Registry Logs](#registry-logs)
*   [NGINX Logs](#nginx-logs)
*   [Pages Logs](#pages-logs)
*   [Mattermost Logs](#mattermost-logs)
*   [Workhorse Logs](#workhorse-logs)
*   [PostgreSQL Logs](#postgresql-logs)
*   [Prometheus Logs](#prometheus-logs)
*   [Redis Logs](#redis-logs)
*   [Alertmanager Logs](#alertmanager-logs)
*   [Crond Logs](#crond-logs)
*   [Grafana Logs](#grafana-logs)
*   [LogRotate Logs](#logrotate-logs)
*   [GitLab Monitor Logs](#gitlab-monitor-logs)
*   [GitLab Exporter](#gitlab-exporter)

# Log system[](#log-system "Permalink")

GitLab 具有一个高级日志系统,可以记录所有内容,因此您可以使用各种系统日志文件分析实例. 除了系统日志文件,GitLab 企业版还提供审核事件. [在审核事件文档中](audit_events.html)找到有关它们的更多信息.

系统日志文件通常是标准日志文件格式的纯文本. 本指南讨论如何读取和使用这些系统日志文件.

## `production_json.log`[](#production_jsonlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/production_json.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/production_json.log`中. 当 GitLab 在生产环境以外的环境中运行时,此处将显示相应的日志文件.

由于[Lograge](https://github.com/roidrage/lograge/) ,它包含从 GitLab 接收到的 Rails 控制器请求的结构化日志. 请注意,来自 API 的请求将记录到`api_json.log`的单独文件中.

每行包含一个可以由 Elasticsearch 和 Splunk 之类的服务提取的 JSON 行. 为了便于阅读,在示例中添加了换行符:

```
{  "method":"GET",  "path":"/gitlab/gitlab-foss/issues/1234",  "format":"html",  "controller":"Projects::IssuesController",  "action":"show",  "status":200,  "time":"2017-08-08T20:15:54.821Z",  "params":[{"key":"param_key","value":"param_value"}],  "remote_ip":"18.245.0.1",  "user_id":1,  "username":"admin",  "queue_duration_s":0.0,  "gitaly_calls":16,  "gitaly_duration_s":0.16,  "redis_calls":115,  "redis_duration_s":0.13,  "redis_read_bytes":1507378,  "redis_write_bytes":2920,  "correlation_id":"O1SdybnnIq7",  "cpu_s":17.50,  "db_duration_s":0.08,  "view_duration_s":2.39,  "duration_s":20.54  } 
```

此示例是针对特定问题的 GET 请求. 每行还包含性能数据,时间以秒为单位:

1.  `duration_s` :检索请求所花费的总时间
2.  `queue_duration_s` :请求在 GitLab Workhorse 中排队的总时间
3.  `view_duration_s` :在 Rails 视图中`view_duration_s`总时间
4.  `db_duration_s` :从 PostgreSQL 检索数据的总时间
5.  `cpu_s` :在 CPU 上花费的总时间
6.  `gitaly_duration_s` :Gitaly 调用花费的总时间
7.  `gitaly_calls` :拨打 Gitaly 的电话总数
8.  `redis_calls` :对 Redis 的呼叫总数
9.  `redis_duration_s` :从 Redis 检索数据的总时间
10.  `redis_read_bytes` :从 Redis 读取的总字节
11.  `redis_write_bytes` :写入 Redis 的总字节数
12.  `redis_<instance>_calls`: total number of calls made to a Redis instance
13.  `redis_<instance>_duration_s` :从 Redis 实例检索数据的总时间
14.  `redis_<instance>_read_bytes` :从 Redis 实例读取的总字节数
15.  `redis_<instance>_write_bytes` :写入 Redis 实例的总字节数

使用 HTTP 传输的用户克隆和获取活动作为`action: git_upload_pack`出现在此日志中`action: git_upload_pack` .

此外,日志还包含原始 IP 地址( `remote_ip` ),用户 ID( `user_id` )和用户名( `username` ).

如果使用[Advanced Global Search,](../user/search/advanced_global_search.html)则某些端点(例如`/search`可能会向 Elasticsearch 发出请求. 这些将另外记录`elasticsearch_calls``elasticsearch_call_duration_s` ,它们对应于:

1.  `elasticsearch_calls` :对 Elasticsearch 的调用总数
2.  `elasticsearch_duration_s` :Elasticsearch 调用花费的总时间

ActionCable 连接和订阅事件也记录到此文件中,它们遵循上面相同的格式. `method``path``format`字段不适用,并且始终为空. ActionCable 连接或通道类用作`controller` .

```
{  "method":{},  "path":{},  "format":{},  "controller":"IssuesChannel",  "action":"subscribe",  "status":200,  "time":"2020-05-14T19:46:22.008Z",  "params":[{"key":"project_path","value":"gitlab/gitlab-foss"},{"key":"iid","value":"1"}],  "remote_ip":"127.0.0.1",  "user_id":1,  "username":"admin",  "ua":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:76.0) Gecko/20100101 Firefox/76.0",  "correlation_id":"jSOIEynHCUa",  "duration_s":0.32566  } 
```

**注意:**从 GitLab 12.5 开始,如果发生错误,则`class``message``backtrace`包含一个`exception`字段. 以前的版本包含一个`error`字段,而不是`exception.class``exception.message` . 例如:

```
{  "method":  "GET",  "path":  "/admin",  "format":  "html",  "controller":  "Admin::DashboardController",  "action":  "index",  "status":  500,  "time":  "2019-11-14T13:12:46.156Z",  "params":  [],  "remote_ip":  "127.0.0.1",  "user_id":  1,  "username":  "root",  "ua":  "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:70.0) Gecko/20100101 Firefox/70.0",  "queue_duration":  274.35,  "correlation_id":  "KjDVUhNvvV3",  "queue_duration_s":0.0,  "gitaly_calls":16,  "gitaly_duration_s":0.16,  "redis_calls":115,  "redis_duration_s":0.13,  "correlation_id":"O1SdybnnIq7",  "cpu_s":17.50,  "db_duration_s":0.08,  "view_duration_s":2.39,  "duration_s":20.54  "exception.class":  "NameError",  "exception.message":  "undefined local variable or method `adsf' for #<Admin::DashboardController:0x00007ff3c9648588>",  "exception.backtrace":  [  "app/controllers/admin/dashboard_controller.rb:11:in `index'",  "ee/app/controllers/ee/admin/dashboard_controller.rb:14:in `index'",  "ee/lib/gitlab/ip_address_state.rb:10:in `with'",  "ee/app/controllers/ee/application_controller.rb:43:in `set_current_ip_address'",  "lib/gitlab/session.rb:11:in `with_session'",  "app/controllers/application_controller.rb:450:in `set_session_storage'",  "app/controllers/application_controller.rb:444:in `set_locale'",  "ee/lib/gitlab/jira/middleware.rb:19:in `call'"  ]  } 
```

## `production.log`[](#productionlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/production.log` ,对于从源代码进行安装,该文件位于`/home/git/gitlab/log/production.log`中. (当 GitLab 在生产环境以外的环境中运行时,此处将显示相应的日志文件.)

它包含有关所有已执行请求的信息. 您可以查看 URL 和请求类型,IP 地址,以及涉及哪些代码部分来满足此特定请求. 此外,您还可以查看所有执行的 SQL 请求以及每个请求花费的时间. 对于 GitLab 贡献者和开发人员来说,此任务更有用. 报告错误时,请使用此日志文件的一部分. 例如:

```
Started GET "/gitlabhq/yaml_db/tree/master" for 168.111.56.1 at 2015-02-12 19:34:53 +0200
Processing by Projects::TreeController#show as HTML
  Parameters: {"project_id"=>"gitlabhq/yaml_db", "id"=>"master"}

  ... [CUT OUT]

  Namespaces"."created_at" DESC, "namespaces"."id" DESC LIMIT 1 [["id", 26]]
  CACHE (0.0ms) SELECT  "members".* FROM "members"  WHERE "members"."source_type" = 'Project' AND "members"."type" IN ('ProjectMember') AND "members"."source_id" = $1 AND "members"."source_type" = $2 AND "members"."user_id" = 1  ORDER BY "members"."created_at" DESC, "members"."id" DESC LIMIT 1  [["source_id", 18], ["source_type", "Project"]]
  CACHE (0.0ms) SELECT  "members".* FROM "members"  WHERE "members"."source_type" = 'Project' AND "members".
  (1.4ms) SELECT COUNT(*) FROM "merge_requests"  WHERE "merge_requests"."target_project_id" = $1 AND ("merge_requests"."state" IN ('opened','reopened')) [["target_project_id", 18]]
  Rendered layouts/nav/_project.html.haml (28.0ms)
  Rendered layouts/_collapse_button.html.haml (0.2ms)
  Rendered layouts/_flash.html.haml (0.1ms)
  Rendered layouts/_page.html.haml (32.9ms)
Completed 200 OK in 166ms (Views: 117.4ms | ActiveRecord: 27.2ms) 
```

在此示例中,服务器在`2015-02-12 19:34:53 +0200`处处理了来自 IP `168.111.56.1` URL `/gitlabhq/yaml_db/tree/master`的 HTTP 请求. 该请求已由`Projects::TreeController` .

## `api_json.log`[](#api_jsonlog "Permalink")

在 GitLab 10.0 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/api_json.log`中,对于从源代码进行安装则位于`/home/git/gitlab/log/api_json.log`中.

它可以帮助您查看直接向 API 发出的请求. 例如:

```
{  "time":"2018-10-29T12:49:42.123Z",  "severity":"INFO",  "duration":709.08,  "db":14.59,  "view":694.49,  "status":200,  "method":"GET",  "path":"/api/v4/projects",  "params":[{"key":"action","value":"git-upload-pack"},{"key":"changes","value":"_any"},{"key":"key_id","value":"secret"},{"key":"secret_token","value":"[FILTERED]"}],  "host":"localhost",  "remote_ip":"::1",  "ua":"Ruby",  "route":"/api/:version/projects",  "user_id":1,  "username":"root",  "queue_duration":100.31,  "gitaly_calls":30,  "gitaly_duration":5.36  } 
```

此项显示一个内部端点,该端点被访问以检查关联的 SSH 密钥是否可以通过`git fetch``git clone`下载有问题的项目. 在此示例中,我们看到:

1.  `duration` :检索请求所花费的总时间(以毫秒为单位)
2.  `queue_duration` :请求在 GitLab Workhorse 中排队的总时间(以毫秒为单位)
3.  `method` :用于发出请求的 HTTP 方法
4.  `path` :查询的相对路径
5.  `params` :在查询字符串或 HTTP 正文中传递的键/值对. 敏感参数(例如密码和令牌)被过滤掉.
6.  `ua` :请求者的用户代理

## `application.log`[](#applicationlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/application.log` ,对于来自源的安装,该文件位于`/home/git/gitlab/log/application.log`中.

它可以帮助您发现实例中发生的事件,例如用户创建,项目删除等. 例如:

```
October 06, 2014 11:56: User "Administrator" (admin@example.com) was created
October 06, 2014 11:56: Documentcloud created a new project "Documentcloud / Underscore"
October 06, 2014 11:56: Gitlab Org created a new project "Gitlab Org / Gitlab Ce"
October 07, 2014 11:25: User "Claudie Hodkiewicz" (nasir_stehr@olson.co.uk)  was removed
October 07, 2014 11:25: Project "project133" was removed 
```

## `application_json.log`[](#application_jsonlog "Permalink")

在 GitLab 12.7 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/22812) .

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/application_json.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/application_json.log`中.

它包含`application.log`日志的 JSON 版本,如下例所示:

```
{  "severity":"INFO",  "time":"2020-01-14T13:35:15.466Z",  "correlation_id":"3823a1550b64417f9c9ed8ee0f48087e",  "message":"User \"Administrator\" (admin@example.com) was created"  }  {  "severity":"INFO",  "time":"2020-01-14T13:35:15.466Z",  "correlation_id":"78e3df10c9a18745243d524540bd5be4",  "message":"Project \"project133\" was removed"  } 
```

## `integrations_json.log`[](#integrations_jsonlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/integrations_json.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/integrations_json.log`中.

它包含有关[集成](../user/project/integrations/overview.html)活动的信息,例如 Jira,Asana 和 Irker 服务. 它使用 JSON 格式,如下例所示:

```
{  "severity":"ERROR",  "time":"2018-09-06T14:56:20.439Z",  "service_class":"JiraService",  "project_id":8,  "project_path":"h5bp/html5-boilerplate",  "message":"Error sending message",  "client_url":"http://jira.gitlap.com:8080",  "error":"execution expired"  }  {  "severity":"INFO",  "time":"2018-09-06T17:15:16.365Z",  "service_class":"JiraService",  "project_id":3,  "project_path":"namespace2/project2",  "message":"Successfully posted",  "client_url":"http://jira.example.com"  } 
```

## `kubernetes.log`[](#kuberneteslog "Permalink")

在 GitLab 11.6 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/kubernetes.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/kubernetes.log`中.

它记录与 Kubernetes 集成相关的信息,包括在托管的 Kubernetes 集群上安装集群应用程序期间的错误.

每行包含一个可以由 Elasticsearch 和 Splunk 之类的服务提取的 JSON 行. 为了清楚起见,在以下示例中添加了换行符:

```
{  "severity":"ERROR",  "time":"2018-11-23T15:14:54.652Z",  "exception":"Kubeclient::HttpError",  "error_code":401,  "service":"Clusters::Applications::CheckInstallationProgressService",  "app_id":14,  "project_ids":[1],  "group_ids":[],  "message":"Unauthorized"  }  {  "severity":"ERROR",  "time":"2018-11-23T15:42:11.647Z",  "exception":"Kubeclient::HttpError",  "error_code":null,  "service":"Clusters::Applications::InstallService",  "app_id":2,  "project_ids":[19],  "group_ids":[],  "message":"SSL_connect returned=1 errno=0 state=error: certificate verify failed (unable to get local issuer certificate)"  } 
```

## `git_json.log`[](#git_jsonlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/git_json.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/git_json.log`中.

**注意:**在 12.2 之后,此文件从`githost.log`重命名为`git_json.log`并以 JSON 格式存储.

GitLab 必须与 Git 存储库进行交互,但是在极少数情况下可能会出问题,在这种情况下,您可能需要知道到底发生了什么. 该日志文件包含从 GitLab 到 Git 存储库的所有失败请求. 在大多数情况下,此文件仅对开发人员有用. 例如:

```
{  "severity":"ERROR",  "time":"2019-07-19T22:16:12.528Z",  "correlation_id":"FeGxww5Hj64",  "message":"Command failed [1]: /usr/bin/git --git-dir=/Users/vsizov/gitlab-development-kit/gitlab/tmp/tests/gitlab-satellites/group184/gitlabhq/.git --work-tree=/Users/vsizov/gitlab-development-kit/gitlab/tmp/tests/gitlab-satellites/group184/gitlabhq merge --no-ff -mMerge branch 'feature_conflict' into 'feature' source/feature_conflict\n\nerror: failed to push some refs to '/Users/vsizov/gitlab-development-kit/repositories/gitlabhq/gitlab_git.git'"  } 
```

## `audit_json.log`[](#audit_jsonlog "Permalink")

**注意:**大多数日志条目仅存在于[GitLab Starter 中](https://about.gitlab.com/pricing/) ,而少数存在于 GitLab Core 中.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/audit_json.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/audit_json.log`中.

组或项目设置的更改将记录到该文件中. 例如:

```
{  "severity":"INFO",  "time":"2018-10-17T17:38:22.523Z",  "author_id":3,  "entity_id":2,  "entity_type":"Project",  "change":"visibility",  "from":"Private",  "to":"Public",  "author_name":"John Doe4",  "target_id":2,  "target_type":"Project",  "target_details":"namespace2/project2"  } 
```

## Sidekiq Logs[](#sidekiq-logs "Permalink")

对于 Omnibus 安装,一些 Sidekiq 日志位于`/var/log/gitlab/sidekiq/current` ,如下所示.

### `sidekiq.log`[](#sidekiqlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/sidekiq.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/sidekiq.log`中.

GitLab 使用后台作业来处理可能需要很长时间的任务. 有关处理这些作业的所有信息都记录到该文件中. 例如:

```
2014-06-10T07:55:20Z 2037 TID-tm504 ERROR: /opt/bitnami/apps/discourse/htdocs/vendor/bundle/ruby/1.9.1/gems/redis-3.0.7/lib/redis/client.rb:228:in `read'
2014-06-10T18:18:26Z 14299 TID-55uqo INFO: Booting Sidekiq 3.0.0 with redis options {:url=>"redis://localhost:6379/0", :namespace=>"sidekiq"} 
```

除了上面的格式,您可以选择为 Sidekiq 生成 JSON 日志. 例如:

```
{  "severity":"INFO",  "time":"2018-04-03T22:57:22.071Z",  "queue":"cronjob:update_all_mirrors",  "args":[],  "class":"UpdateAllMirrorsWorker",  "retry":false,  "queue_namespace":"cronjob",  "jid":"06aeaa3b0aadacf9981f368e",  "created_at":"2018-04-03T22:57:21.930Z",  "enqueued_at":"2018-04-03T22:57:21.931Z",  "pid":10077,  "message":"UpdateAllMirrorsWorker JID-06aeaa3b0aadacf9981f368e: done: 0.139 sec",  "job_status":"done",  "duration":0.139,  "completed_at":"2018-04-03T22:57:22.071Z",  "db_duration":0.05,  "db_duration_s":0.0005,  "gitaly_duration":0,  "gitaly_calls":0  } 
```

对于 Omnibus GitLab 安装,请添加配置选项:

```
sidekiq['log_format'] = 'json' 
```

对于源代码安装,请编辑`gitlab.yml`并设置 Sidekiq `log_format`配置选项:

```
 ## Sidekiq
  sidekiq:
    log_format: json 
```

### `sidekiq_client.log`[](#sidekiq_clientlog "Permalink")

在 GitLab 12.9 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/26586) .

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/sidekiq_client.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/sidekiq_client.log`中.

该文件包含有关 Sidekiq 开始处理作业之前(例如,入队前)的日志信息.

该日志文件采用与[`sidekiq.log`](#sidekiqlog)相同的结构,因此,如果您如上所述为 Sidekiq 配置了此文件,则该文件将构造为 JSON.

## `gitlab-shell.log`[](#gitlab-shelllog "Permalink")

GitLab 使用 GitLab Shell 执行 Git 命令,并提供对 Git 存储库的 SSH 访问.

### For GitLab versions 12.10 and up[](#for-gitlab-versions-1210-and-up "Permalink")

对于 GitLab 版本 12.10 和更高版本,有 2 个`gitlab-shell.log`文件. 包含`git-{upload-pack,receive-pack}`请求的信息位于`/var/log/gitlab/gitlab-shell/gitlab-shell.log` . 来自 Gitaly 的与 GitLab Shell 挂钩的信息位于`/var/log/gitlab/gitaly/gitlab-shell.log` .

`/var/log/gitlab/gitlab-shell/gitlab-shell.log`示例日志条目:

```
{  "duration_ms":  74.104,  "level":  "info",  "method":  "POST",  "msg":  "Finished HTTP request",  "time":  "2020-04-17T20:28:46Z",  "url":  "http://127.0.0.1:8080/api/v4/internal/allowed"  }  {  "command":  "git-upload-pack",  "git_protocol":  "",  "gl_project_path":  "root/example",  "gl_repository":  "project-1",  "level":  "info",  "msg":  "executing git command",  "time":  "2020-04-17T20:28:46Z",  "user_id":  "user-1",  "username":  "root"  } 
```

`/var/log/gitlab/gitaly/gitlab-shell.log`示例日志条目:

```
{  "method":  "POST",  "url":  "http://127.0.0.1:8080/api/v4/internal/allowed",  "duration":  0.058012959,  "gitaly_embedded":  true,  "pid":  16636,  "level":  "info",  "msg":  "finished HTTP request",  "time":  "2020-04-17T20:29:08+00:00"  }  {  "method":  "POST",  "url":  "http://127.0.0.1:8080/api/v4/internal/pre_receive",  "duration":  0.031022552,  "gitaly_embedded":  true,  "pid":  16636,  "level":  "info",  "msg":  "finished HTTP request",  "time":  "2020-04-17T20:29:08+00:00"  } 
```

### For GitLab versions 12.5 through 12.9[](#for-gitlab-versions-125-through-129 "Permalink")

对于 GitLab 12.5 至 12.9,对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitaly/gitlab-shell.log` ,对于从源代码进行安装则位于`/home/git/gitaly/gitlab-shell.log`中.

Example log entries:

```
{  "method":  "POST",  "url":  "http://127.0.0.1:8080/api/v4/internal/post_receive",  "duration":  0.031809164,  "gitaly_embedded":  true,  "pid":  27056,  "level":  "info",  "msg":  "finished HTTP request",  "time":  "2020-04-17T16:24:38+00:00"  } 
```

### For GitLab 12.5 and earlier[](#for-gitlab-125-and-earlier "Permalink")

对于 GitLab 12.5 和更早版本,该文件位于`/var/log/gitlab/gitlab-shell/gitlab-shell.log` .

示例日志条目:

```
I, [2015-02-13T06:17:00.671315 #9291]  INFO -- : Adding project root/example.git at </var/opt/gitlab/git-data/repositories/root/dcdcdcdcd.git>.
I, [2015-02-13T06:17:00.679433 #9291]  INFO -- : Moving existing hooks directory and symlinking global hooks directory for /var/opt/gitlab/git-data/repositories/root/example.git. 
```

`executing git command <gitaly-upload-pack...`使用 SSH 传输的用户克隆/获取活动将出现在此日志中.

## Gitaly Logs[](#gitaly-logs "Permalink")

该文件位于`/var/log/gitlab/gitaly/current` ,由[runit 生成](http://smarden.org/runit/) . `runit`与 Omnibus GitLab 打包在一起,其用途的简要说明[在 Omnibus GitLab 文档中提供](https://docs.gitlab.com/omnibus/architecture/) . [日志文件被旋转](http://smarden.org/runit/svlogd.8.html) ,以 Unix 时间戳格式重命名,并经过`gzip`压缩(如`@1584057562.s` ).

### `grpc.log`[](#grpclog "Permalink")

该文件位于 Omnibus GitLab 软件包的`/var/log/gitlab/gitlab-rails/grpc.log`中. [Gitaly](https://grpc.io/)使用的本机[gRPC](https://grpc.io/)日志记录.

## Puma Logs[](#puma-logs "Permalink")

### `puma_stdout.log`[](#puma_stdoutlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/puma/puma_stdout.log`中,对于从源代码进行的安装,该文件位于`/home/git/gitlab/log/puma_stdout.log`中.

### `puma_stderr.log`[](#puma_stderrlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/puma/puma_stderr.log`中,对于从源代码进行的安装则位于`/home/git/gitlab/log/puma_stderr.log`中.

## Unicorn Logs[](#unicorn-logs "Permalink")

**注意:**从 GitLab 13.0 开始,Puma 是基于 GitLab 多合一软件包的安装以及 GitLab Helm 图表部署中使用的默认 Web 服务器.

### `unicorn_stdout.log`[](#unicorn_stdoutlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/unicorn/unicorn_stdout.log`中,对于从源代码进行的安装,该文件位于`/home/git/gitlab/log/unicorn_stdout.log`中.

### `unicorn_stderr.log`[](#unicorn_stderrlog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/unicorn/unicorn_stderr.log`中,对于来自源的安装,该文件位于`/home/git/gitlab/log/unicorn_stderr.log`中.

这些日志包含有关任何给定时间 Unicorn 进程状态的所有信息.

```
I, [2015-02-13T06:14:46.680381 #9047]  INFO -- : Refreshing Gem list
I, [2015-02-13T06:14:56.931002 #9047]  INFO -- : listening on addr=127.0.0.1:8080 fd=12
I, [2015-02-13T06:14:56.931381 #9047]  INFO -- : listening on addr=/var/opt/gitlab/gitlab-rails/sockets/gitlab.socket fd=13
I, [2015-02-13T06:14:56.936638 #9047]  INFO -- : master process ready
I, [2015-02-13T06:14:56.946504 #9092]  INFO -- : worker=0 spawned pid=9092
I, [2015-02-13T06:14:56.946943 #9092]  INFO -- : worker=0 ready
I, [2015-02-13T06:14:56.947892 #9094]  INFO -- : worker=1 spawned pid=9094
I, [2015-02-13T06:14:56.948181 #9094]  INFO -- : worker=1 ready
W, [2015-02-13T07:16:01.312916 #9094]  WARN -- : #<Unicorn::HttpServer:0x0000000208f618>: worker (pid: 9094) exceeds memory limit (320626688 bytes > 247066940 bytes)
W, [2015-02-13T07:16:01.313000 #9094]  WARN -- : Unicorn::WorkerKiller send SIGQUIT (pid: 9094) alive: 3621 sec (trial 1)
I, [2015-02-13T07:16:01.530733 #9047]  INFO -- : reaped #<Process::Status: pid 9094 exit 0> worker=1
I, [2015-02-13T07:16:01.534501 #13379]  INFO -- : worker=1 spawned pid=13379
I, [2015-02-13T07:16:01.534848 #13379]  INFO -- : worker=1 ready 
```

## `repocheck.log`[](#repochecklog "Permalink")

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/repocheck.log` ,对于来自源的安装,该文件位于`/home/git/gitlab/log/repocheck.log`中.

每当在项目上[运行存储库检查](repository_checks.html)时,它都会记录信息.

## `importer.log`[](#importerlog "Permalink")

在 GitLab 11.3 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/importer.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/importer.log`中.

它记录导入过程的进度.

## `exporter.log`[](#exporterlog "Permalink")

在 GitLab 13.1 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/exporter.log` ,对于来自源的安装,该文件位于`/home/git/gitlab/log/exporter.log`中.

它记录导出过程的进度.

## `auth.log`[](#authlog "Permalink")

在 GitLab 12.0 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/auth.log` ,对于来自源的安装,该文件位于`/home/git/gitlab/log/auth.log`中.

该日志记录:

*   每当[Rack Attack](../security/rack_attack.html)注册滥用请求时提供的信息.
*   请求超过原始端点上的[速率限制](../user/admin_area/settings/rate_limits_on_raw_endpoints.html) .
*   [受保护的路径](../user/admin_area/settings/protected_paths.html)滥用请求.

**注意:**在 GitLab [12.3](https://gitlab.com/gitlab-org/gitlab/-/issues/29239)和更高版本中,用户 ID 和用户名也会记录在该日志中(如果有).

## `graphql_json.log`[](#graphql_jsonlog "Permalink")

[Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/59587) in GitLab 12.0.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/graphql_json.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/graphql_json.log`中.

GraphQL 查询记录在该文件中. 例如:

```
{"query_string":"query IntrospectionQuery{__schema {queryType { name },mutationType { name }}}...(etc)","variables":{"a":1,"b":2},"complexity":181,"depth":1,"duration_s":7} 
```

## `migrations.log`[](#migrationslog "Permalink")

在 GitLab 12.3 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/migrations.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/migrations.log`中.

## `mail_room_json.log` (default)[](#mail_room_jsonlog-default "Permalink")

在 GitLab 12.6 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19186) .

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/mailroom/current` ,对于来自源的安装,该文件位于`/home/git/gitlab/log/mail_room_json.log`中.

这个结构化的日志文件将内部活动记录在`mail_room` gem 中. 它的名称和路径是可配置的,因此名称和路径可能与上面的不匹配.

## Reconfigure Logs[](#reconfigure-logs "Permalink")

为 Omnibus GitLab 软件包`/var/log/gitlab/reconfigure`日志文件. 从源安装没有重新配置日志. 每当手动或作为升级的一部分运行`gitlab-ctl reconfigure`时, `gitlab-ctl reconfigure`填充一个重配置日志.

根据启动重新配置的 UNIX 时间戳记来命名重新配置日志文件,例如`1509705644.log`

## `sidekiq_exporter.log` and `web_exporter.log`[](#sidekiq_exporterlog-and-web_exporterlog "Permalink")

如果同时启用了 Prometheus 指标和 Sidekiq 导出器,则 Sidekiq 将启动 Web 服务器并侦听定义的端口(默认值: `8082` ). 对于 Omnibus GitLab 软件包,访问日志将在`/var/log/gitlab/gitlab-rails/sidekiq_exporter.log`中生成,对于从源代码进行的安装,将在`/home/git/gitlab/log/sidekiq_exporter.log`生成.

如果同时启用了 Prometheus 指标和 Web 导出器,则 Puma / Unicorn 将启动 Web 服务器并侦听定义的端口(默认值: `8083` ). 对于 Omnibus GitLab 软件包,访问日志将在`/var/log/gitlab/gitlab-rails/web_exporter.log`中生成,对于源安装,将在`/home/git/gitlab/log/web_exporter.log`生成.

## `database_load_balancing.log`[](#database_load_balancinglog-premium-only "Permalink")

在 GitLab 12.3 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/15442) .

包含 GitLab 的[数据库负载平衡的](database_load_balancing.html)详细信息. 它存储在:

*   `/var/log/gitlab/gitlab-rails/database_load_balancing.log`用于 Omnibus GitLab 软件包.
*   `/home/git/gitlab/log/database_load_balancing.log`用于从源代码进行安装.

## `elasticsearch.log`[](#elasticsearchlog-starter-only "Permalink")

在 GitLab 12.6 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/elasticsearch.log` ,对于来自源的安装,该文件位于`/home/git/gitlab/log/elasticsearch.log`中.

它记录与 Elasticsearch Integration 相关的信息,包括在索引或搜索 Elasticsearch 期间发生的错误.

每行包含一个可以由 Elasticsearch 和 Splunk 之类的服务提取的 JSON 行. 为了清楚起见,在以下示例行中添加了换行符:

```
{  "severity":"DEBUG",  "time":"2019-10-17T06:23:13.227Z",  "correlation_id":null,  "message":"redacted_search_result",  "class_name":"Milestone",  "id":2,  "ability":"read_milestone",  "current_user_id":2,  "query":"project"  } 
```

## `exceptions_json.log`[](#exceptions_jsonlog "Permalink")

在 GitLab 12.6 中[引入](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17819) .

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/exceptions_json.log` ,对于从源代码进行安装则位于`/home/git/gitlab/log/exceptions_json.log`中.

它记录有关`Gitlab::ErrorTracking`跟踪的异常的信息,该信息提供了一种标准且一致的方式来[处理已获救的异常](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/development/logging.md#exception-handling) .

每行包含一个可由 Elasticsearch 摄取的 JSON 行. 例如:

```
{  "severity":  "ERROR",  "time":  "2019-12-17T11:49:29.485Z",  "correlation_id":  "AbDVUrrTvM1",  "extra.project_id":  55,  "extra.relation_key":  "milestones",  "extra.relation_index":  1,  "exception.class":  "NoMethodError",  "exception.message":  "undefined method `strong_memoize' for #<Gitlab::ImportExport::RelationFactory:0x00007fb5d917c4b0>",  "exception.backtrace":  [  "lib/gitlab/import_export/relation_factory.rb:329:in `unique_relation?'",  "lib/gitlab/import_export/relation_factory.rb:345:in `find_or_create_object!'"  ]  } 
```

## `service_measurement.log`[](#service_measurementlog "Permalink")

在 GitLab 13.0 中引入.

对于 Omnibus GitLab 软件包,此文件位于`/var/log/gitlab/gitlab-rails/service_measurement.log` ,对于来自源的安装,该文件位于`/home/git/gitlab/log/service_measurement.log`中.

它仅包含一个结构化日志,其中包含每个服务执行的度量. 它将包含诸如 SQL 调用数, `execution_time``gc_stats``memory usage` `gc_stats` .

例如:

```
{  "severity":"INFO",  "time":"2020-04-22T16:04:50.691Z","correlation_id":"04f1366e-57a1-45b8-88c1-b00b23dc3616","class":"Projects::ImportExport::ExportService","current_user":"John Doe","project_full_path":"group1/test-export","file_path":"/path/to/archive","gc_stats":{"count":{"before":127,"after":127,"diff":0},"heap_allocated_pages":{"before":10369,"after":10369,"diff":0},"heap_sorted_length":{"before":10369,"after":10369,"diff":0},"heap_allocatable_pages":{"before":0,"after":0,"diff":0},"heap_available_slots":{"before":4226409,"after":4226409,"diff":0},"heap_live_slots":{"before":2542709,"after":2641420,"diff":98711},"heap_free_slots":{"before":1683700,"after":1584989,"diff":-98711},"heap_final_slots":{"before":0,"after":0,"diff":0},"heap_marked_slots":{"before":2542704,"after":2542704,"diff":0},"heap_eden_pages":{"before":10369,"after":10369,"diff":0},"heap_tomb_pages":{"before":0,"after":0,"diff":0},"total_allocated_pages":{"before":10369,"after":10369,"diff":0},"total_freed_pages":{"before":0,"after":0,"diff":0},"total_allocated_objects":{"before":24896308,"after":24995019,"diff":98711},"total_freed_objects":{"before":22353599,"after":22353599,"diff":0},"malloc_increase_bytes":{"before":140032,"after":6650240,"diff":6510208},"malloc_increase_bytes_limit":{"before":25804104,"after":25804104,"diff":0},"minor_gc_count":{"before":94,"after":94,"diff":0},"major_gc_count":{"before":33,"after":33,"diff":0},"remembered_wb_unprotected_objects":{"before":34284,"after":34284,"diff":0},"remembered_wb_unprotected_objects_limit":{"before":68568,"after":68568,"diff":0},"old_objects":{"before":2404725,"after":2404725,"diff":0},"old_objects_limit":{"before":4809450,"after":4809450,"diff":0},"oldmalloc_increase_bytes":{"before":140032,"after":6650240,"diff":6510208},"oldmalloc_increase_bytes_limit":{"before":68537556,"after":68537556,"diff":0}},"time_to_finish":0.12298400001600385,"number_of_sql_calls":70,"memory_usage":"0.0 MiB","label":"process_48616"} 
```

## `geo.log`[](#geolog-premium-only "Permalink")

> 在 9.5 中引入.

Geo 将结构化日志消息存储在`geo.log`文件中. 对于 Omnibus 安装,此文件位于`/var/log/gitlab/gitlab-rails/geo.log` .

该文件包含有关 Geo 何时尝试同步存储库和文件的信息. 文件中的每一行都包含一个可以提取的单独的 JSON 条目. 例如,Elasticsearch 或 Splunk.

For example:

```
{"severity":"INFO","time":"2017-08-06T05:40:16.104Z","message":"Repository update","project_id":1,"source":"repository","resync_repository":true,"resync_wiki":true,"class":"Gitlab::Geo::LogCursor::Daemon","cursor_delay_s":0.038} 
```

此消息表明,Geo 检测到项目`1`需要存储库更新.

## Registry Logs[](#registry-logs "Permalink")

对于 Omnibus 安装,容器注册表日志位于`/var/log/gitlab/registry/current` .

## NGINX Logs[](#nginx-logs "Permalink")

对于 Omnibus 安装,NGINX 日志位于:

*   `/var/log/gitlab/nginx/gitlab_access.log`包含对 GitLab 的请求的日志.
*   `/var/log/gitlab/nginx/gitlab_error.log`包含有关 GitLab 的 NGINX 错误的日志.
*   `/var/log/gitlab/nginx/gitlab_pages_access.log`包含对 Pages 静态站点的请求的日志.
*   `/var/log/gitlab/nginx/gitlab_pages_error.log`包含 Pages 静态站点的 NGINX 错误日志.
*   `/var/log/gitlab/nginx/gitlab_registry_access.log`包含对容器注册表进行的请求的日志.
*   `/var/log/gitlab/nginx/gitlab_registry_error.log`包含容器注册表的 NGINX 错误日志.
*   `/var/log/gitlab/nginx/gitlab_mattermost_access.log`包含对 Mattermost 的请求日志.
*   `/var/log/gitlab/nginx/gitlab_mattermost_error.log`包含 Mattermost 的 NGINX 错误日志.

以下是默认的 GitLab NGINX 访问日志格式:

```
$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" 
```

## Pages Logs[](#pages-logs "Permalink")

对于 Omnibus 安装,Pages 日志位于`/var/log/gitlab/gitlab-pages/current` .

例如:

```
{  "level":  "info",  "msg":  "GitLab Pages Daemon",  "revision":  "52b2899",  "time":  "2020-04-22T17:53:12Z",  "version":  "1.17.0"  }  {  "level":  "info",  "msg":  "URL: https://gitlab.com/gitlab-org/gitlab-pages",  "time":  "2020-04-22T17:53:12Z"  }  {  "gid":  998,  "in-place":  false,  "level":  "info",  "msg":  "running the daemon as unprivileged user",  "time":  "2020-04-22T17:53:12Z",  "uid":  998  } 
```

## Mattermost Logs[](#mattermost-logs "Permalink")

For Omnibus GitLab installations, Mattermost logs reside in `/var/log/gitlab/mattermost/mattermost.log`.

## Workhorse Logs[](#workhorse-logs "Permalink")

对于 Omnibus GitLab 安装,Workhorse 日志位于`/var/log/gitlab/gitlab-workhorse/` .

## PostgreSQL Logs[](#postgresql-logs "Permalink")

对于 Omnibus GitLab 安装,PostgreSQL 日志位于`/var/log/gitlab/postgresql/` .

## Prometheus Logs[](#prometheus-logs "Permalink")

对于 Omnibus GitLab 安装,Prometheus 日志位于`/var/log/gitlab/prometheus/` .

## Redis Logs[](#redis-logs "Permalink")

对于所有安装的 GitLab,它返回的日志位于`/var/log/gitlab/redis/` .

## Alertmanager Logs[](#alertmanager-logs "Permalink")

对于 Omnibus GitLab 安装,Alertmanager 日志位于`/var/log/gitlab/alertmanager/` .

## Crond Logs[](#crond-logs "Permalink")

对于 Omnibus GitLab 安装,crond 日志位于`/var/log/gitlab/crond/` .

## Grafana Logs[](#grafana-logs "Permalink")

对于 Omnibus GitLab 安装,Grafana 日志位于`/var/log/gitlab/grafana/` .

## LogRotate Logs[](#logrotate-logs "Permalink")

对于 Omnibus GitLab 安装,logrotate 日志位于`/var/log/gitlab/logrotate/` .

## GitLab Monitor Logs[](#gitlab-monitor-logs "Permalink")

对于 Omnibus GitLab 安装,GitLab Monitor 日志位于`/var/log/gitlab/gitlab-monitor/` .

## GitLab Exporter[](#gitlab-exporter "Permalink")

对于 Omnibus GitLab 安装,GitLab Exporter 日志位于`/var/log/gitlab/gitlab-exporter/` .