GitLabgitlab-org

cli

main
ply7 git calls327 ms98 KiB4 cachedprotocol v2
79 lines2.5 KiBRaw

Summarize Dependency Firewall activity from the CI log. (BETA)

Synopsis

Read .gitlab/df/ci-log.json and print blocked and flagged packages recorded during a glab dependency-firewall run.

The log is read from the current working directory and, when set, from the directory in GLAB_DF_CI_LOG_DIR. Run this command from the same directory as the glab dependency-firewall run that wrote the log, otherwise no activity is reported. The job-level proxy sets GLAB_DF_CI_LOG_DIR, so jobs that use it can run this command from any directory.

To fail a CI/CD job when any package was blocked, run this command as the last command in script. This catches a block even when a package manager continues after a refused download. In after_script, the command prints the report but can't fail the job, because GitLab ignores after_script exit codes.

yaml
install:
  variables:
    GLAB_ENABLE_CI_AUTOLOGIN: "true"
  script:
    - glab dependency-firewall npm ci
    - glab dependency-firewall pip install -r requirements.txt
    - glab dependency-firewall ci-summary

Entries accumulate across runs, and the command never clears them. A block from an earlier run keeps the command exiting with 3 until you delete .gitlab/df/ci-log.json.

Exit codeMeaning
0No blocked entries in the log (allow-only or warnings).
1The log could not be read.
3At least one entry in the log is blocked.

This feature is in beta and might not be ready for production use. It might be unstable and breaking changes can occur outside of major releases. For more information, see https://docs.gitlab.com/policy/development_stages_support/.

plaintext
glab dependency-firewall ci-summary [flags]

Examples

console
# Show blocked and flagged packages from the last firewall run
glab dependency-firewall ci-summary

Environment variables

plaintext
GLAB_DF_CI_LOG_DIR: a directory whose .gitlab/df/ci-log.json is read in addition to the working directory's. The job-level proxy sets it.

Options inherited from parent commands

plaintext
  -h, --help   Show help for this command.
1---
2title: '`glab dependency-firewall ci-summary`'
3stage: AI Clients
4group: Developer Clients
5info: To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>
6---
8<!--
9This documentation is auto generated by a script.
10Please do not edit this file directly. Run `make gen-docs` instead.
11-->
13Summarize Dependency Firewall activity from the CI log. (BETA)
15## Synopsis
17Read `.gitlab/df/ci-log.json` and print blocked and flagged packages
18recorded during a `glab dependency-firewall` run.
20The log is read from the current working directory and, when set, from the
21directory in `GLAB_DF_CI_LOG_DIR`. Run this command from the same directory
22as the `glab dependency-firewall` run that wrote the log, otherwise no
23activity is reported. The job-level proxy sets `GLAB_DF_CI_LOG_DIR`, so jobs
24that use it can run this command from any directory.
26To fail a CI/CD job when any package was blocked, run this command as the
27last command in `script`. This catches a block even when a package
28manager continues after a refused download. In `after_script`, the
29command prints the report but can't fail the job, because GitLab ignores
30`after_script` exit codes.
32```yaml
33install:
34 variables:
35 GLAB_ENABLE_CI_AUTOLOGIN: "true"
36 script:
37 - glab dependency-firewall npm ci
38 - glab dependency-firewall pip install -r requirements.txt
39 - glab dependency-firewall ci-summary
40```
42Entries accumulate across runs, and the command never clears them. A block
43from an earlier run keeps the command exiting with `3` until you delete
44`.gitlab/df/ci-log.json`.
46| Exit code | Meaning |
47|-----------|---------|
48| `0` | No blocked entries in the log (allow-only or warnings). |
49| `1` | The log could not be read. |
50| `3` | At least one entry in the log is blocked. |
52This feature is in beta and might not be ready for production use.
53It might be unstable and breaking changes can occur outside of major releases.
54For more information, see
55<https://docs.gitlab.com/policy/development_stages_support/>.
57```plaintext
58glab dependency-firewall ci-summary [flags]
59```
61## Examples
63```console
64# Show blocked and flagged packages from the last firewall run
65glab dependency-firewall ci-summary
67```
69## Environment variables
71```plaintext
72GLAB_DF_CI_LOG_DIR: a directory whose .gitlab/df/ci-log.json is read in addition to the working directory's. The job-level proxy sets it.
73```
75## Options inherited from parent commands
77```plaintext
78 -h, --help Show help for this command.
79```
Diagnostics7 git calls · 327 ms
CallStatusSizeTime0327 ms
discover200185 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=UPDATING
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchtree:02001.7 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=1744
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=5e4007a5673eb3bf5d0d7f1a1463c3b2ca3fb3bd
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1744
git.pkt.payload.max=1717
git.sideband.band1.bytes=1717
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=1717
git.pack.trailer=3f1b9ccc7756e8941d6705e8187c87fd922113e6
Open pack map
fetchtree:0200603 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=318
git.response.bytes=603
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=5176f4db5d2291e59ebb86e84c285997df7bb735
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=603
git.pkt.payload.max=576
git.sideband.band1.bytes=576
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=576
git.pack.trailer=d6a5813e7d910c309af173a8e72c7467abf35dc7
Open pack map
fetch2001.3 KiB318 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1280
git.response.cache=MISS
git.response.duration_ms=318
git.fetch.wants=59cb076157a637fc334ae65994e61133d74149f9
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1280
git.pkt.payload.max=1253
git.sideband.band1.bytes=1253
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e214c11d62984a
Request
3fa7d52b…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format