Wie man Dateigröße mit Bencher verfolgt

Bencher supports the most popular benchmarking harnesses out-of-the-box. Sometimes though, you want to measure the size of your deliverables themselves, such as the binary size of an executable. Lucky for you, Bencher also supports tracking file size. The easiest way to track file size is to use the bencher run CLI subcommand with the --file-size option. The --file-size option expects a file path to the file who’s size will be measured. Under the hood, bencher run outputs the results as Bencher Metric Format (BMF) JSON. It is therefore good practice to explicitly use the json adapter.

If you had a script located at ./my_build_script.sh that built your binary at the path ./path/to/my_binary, then you could track the size of this binary file with bencher run and the json adapter. This would work both with a benchmark command and without one.

With a benchmark command:

bencher run --file-size ./path/to/my_binary --adapter json ./my_build_script.sh

Without a benchmark command:

./my_build_script.sh && bencher run --file-size ./path/to/my_binary --adapter json

In either case, the generated BMF JSON would look like this, if my_binary had a size of 42 bytes:

{
  "my_binary": {
    "file-size": {
      "value": 42.0
    }
  }
}

In this example, the key my_binary is the binary file name. It is used as the name of the Benchmark. The my_binary object contains the file-size key. file-size is the slug for the built-in File Size Measure. The File Size Measure is not created by default for all Projects. However, when you use the File Size Measure, it will be automatically created for your Project. The File Size Measure object contains a Metric with the file size value in bytes, 42.0.

The File Size will always be a whole byte increment. That is, it will never have a decimal like 42.5. However, BMF JSON needs to support a wide range of possible values, so it uses floats instead of integers.

Mehrere Dateigrößen

Wenn Sie die Größe mehrerer Dateien verfolgen möchten, können Sie die Option --file-size einfach mehrfach im selben bencher run-Befehl verwenden. Zum Beispiel könnten Sie sowohl my_binary als auch eine Windows ausführbare Version, my_binary.exe, verfolgen.

bencher run --file-size ./path/to/my_binary --file-size ./path/to/my_binary.exe --adapter json ./my_build_script.sh

Das generierte BMF JSON würde so aussehen, wenn my_binary.exe eine Größe von 48 Bytes hat:

{
  "my_binary": {
    "file-size": {
      "value": 42.0
    }
  },
  "my_binary.exe": {
    "file-size": {
      "value": 48.0
    }
  }
}

Buildzeit verfolgen

Sie möchten möglicherweise die Buildzeit verfolgen Ihrer Liefergegenstände, zusätzlich zur Verfolgung ihrer Dateigröße. bencher run unterstützt sowohl die Verfolgung von Dateigrößen als auch von Buildzeiten.

Sie könnten sowohl die Binärgröße als auch die Kompilierzeit für my_binary mit diesem Befehl verfolgen:

bencher run --file-size ./path/to/my_binary --build-time --adapter json ./my_build_script.sh

Wenn Ihr Build-Skript 87,0 Sekunden benötigte, um abzuschließen, würde das generierte BMF JSON so aussehen:

{
  "my_binary": {
    "file-size": {
      "value": 42.0
    }
  },
  "/bin/sh -c ./my_build_script.sh": {
    "build-time": {
      "value": 87.0
    }
  }
}

🐰 Glückwunsch! Du hast gelernt, wie du deine Dateigröße verfolgen kannst! 🎉

Mach weiter: Wie man Benchmarks in CI verfolgt ➡