Comment Suivre la Taille des Fichiers avec Bencher

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.

Tailles de fichiers multiples

Si vous voulez suivre la taille de plusieurs fichiers, vous pouvez simplement utiliser l’option --file-size plusieurs fois dans la même bencher run commande. Par exemple, vous pourriez suivre à la fois my_binary et une version exécutable Windows, my_binary.exe.

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

Le JSON BMF généré ressemblerait à ceci si my_binary.exe a une taille de 48 bytes:

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

Suivre le temps de compilation

Vous voudrez peut-être suivre le temps de compilation de vos livrables, en plus de suivre leur taille de fichier. bencher run supporte le suivi à la fois des tailles de fichiers et des temps de compilation.

Vous pourriez suivre à la fois la taille binaire et le temps de compilation pour my_binary avec cette commande :

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

Si votre script de construction a pris 87,0 secondes pour s’exécuter, le JSON BMF généré ressemblerait à ceci :

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

🐰 Félicitations ! Vous avez appris à suivre la taille de vos fichiers ! 🎉

Continuez : Comment Suivre les Benchmarks dans l’Intégration Continue ➡