diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix index 9ed87b018a7c..39f28773eab0 100644 --- a/nixos/modules/module-list.nix +++ b/nixos/modules/module-list.nix @@ -332,6 +332,7 @@ ./services/desktops/tumbler.nix ./services/desktops/zeitgeist.nix ./services/development/bloop.nix + ./services/development/blackfire.nix ./services/development/hoogle.nix ./services/development/jupyter/default.nix ./services/development/jupyterhub/default.nix diff --git a/nixos/modules/services/development/blackfire.nix b/nixos/modules/services/development/blackfire.nix new file mode 100644 index 000000000000..6fd948cce38d --- /dev/null +++ b/nixos/modules/services/development/blackfire.nix @@ -0,0 +1,65 @@ +{ config, lib, pkgs, ... }: + +let + cfg = config.services.blackfire-agent; + + agentConfigFile = lib.generators.toINI {} { + blackfire = cfg.settings; + }; + + agentSock = "blackfire/agent.sock"; +in { + meta = { + maintainers = pkgs.blackfire.meta.maintainers; + doc = ./blackfire.xml; + }; + + options = { + services.blackfire-agent = { + enable = lib.mkEnableOption "Blackfire profiler agent"; + settings = lib.mkOption { + description = '' + See https://blackfire.io/docs/configuration/agent + ''; + type = lib.types.submodule { + freeformType = with lib.types; attrsOf str; + + options = { + server-id = lib.mkOption { + type = lib.types.str; + description = '' + Sets the server id used to authenticate with Blackfire + + You can find your personal server-id at https://blackfire.io/my/settings/credentials + ''; + }; + + server-token = lib.mkOption { + type = lib.types.str; + description = '' + Sets the server token used to authenticate with Blackfire + + You can find your personal server-token at https://blackfire.io/my/settings/credentials + ''; + }; + }; + }; + }; + }; + }; + + config = lib.mkIf cfg.enable { + environment.etc."blackfire/agent".text = agentConfigFile; + + services.blackfire-agent.settings.socket = "unix:///run/${agentSock}"; + + systemd.services.blackfire-agent = { + description = "Blackfire agent"; + + serviceConfig = { + ExecStart = "${pkgs.blackfire}/bin/blackfire-agent"; + RuntimeDirectory = "blackfire"; + }; + }; + }; +} diff --git a/nixos/modules/services/development/blackfire.xml b/nixos/modules/services/development/blackfire.xml new file mode 100644 index 000000000000..ad4af35788db --- /dev/null +++ b/nixos/modules/services/development/blackfire.xml @@ -0,0 +1,45 @@ + + Blackfire profiler + + Source: + modules/services/development/blackfire.nix + + + Upstream documentation: + + + + Blackfire is a proprietary tool for profiling applications. There are several languages supported by the product but currently only PHP support is packaged in Nixpkgs. The back-end consists of a module that is loaded into the language runtime (called probe) and a service (agent) that the probe connects to and that sends the profiles to the server. + + + To use it, you will need to enable the agent and the probe on your server. The exact method will depend on the way you use PHP but here is an example of NixOS configuration for PHP-FPM: +let + php = pkgs.php.withExtensions ({ enabled, all }: enabled ++ (with all; [ + blackfire + ])); +in { + # Enable the probe extension for PHP-FPM. + services.phpfpm = { + phpPackage = php; + }; + + # Enable and configure the agent. + services.blackfire-agent = { + enable = true; + settings = { + # You will need to get credentials at https://blackfire.io/my/settings/credentials + # You can also use other options described in https://blackfire.io/docs/configuration/agent + server-id = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; + server-token = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; + }; + }; + + # Make the agent run on start-up. + # Alternately, you can start it manually with `systemctl start blackfire-agent`. + systemd.services.blackfire-agent.wantedBy = [ "phpfpm-foo.service" ]; +} + + + On your developer machine, you will also want to install the client (see blackfire package) or the browser extension to actually trigger the profiling. + + diff --git a/pkgs/development/interpreters/php/default.nix b/pkgs/development/interpreters/php/default.nix index a2e546b82613..8286de744ed8 100644 --- a/pkgs/development/interpreters/php/default.nix +++ b/pkgs/development/interpreters/php/default.nix @@ -106,7 +106,7 @@ let name = "php-with-extensions-${version}"; inherit (php) version; nativeBuildInputs = [ makeWrapper ]; - passthru = { + passthru = php.passthru // { buildEnv = mkBuildEnv allArgs allExtensionFunctions; withExtensions = mkWithExtensions allArgs allExtensionFunctions; phpIni = "${phpWithExtensions}/lib/php.ini"; @@ -259,6 +259,7 @@ let passthru = { buildEnv = mkBuildEnv {} []; withExtensions = mkWithExtensions {} []; + inherit ztsSupport; }; meta = with stdenv.lib; { diff --git a/pkgs/development/tools/misc/blackfire/default.nix b/pkgs/development/tools/misc/blackfire/default.nix new file mode 100644 index 000000000000..08496d9f5202 --- /dev/null +++ b/pkgs/development/tools/misc/blackfire/default.nix @@ -0,0 +1,52 @@ +{ stdenv +, lib +, fetchurl +, dpkg +, autoPatchelfHook +, writeShellScript +, curl +, jq +, common-updater-scripts +}: + +stdenv.mkDerivation rec { + pname = "blackfire-agent"; + version = "1.44.1"; + + src = fetchurl { + url = "https://packages.blackfire.io/debian/pool/any/main/b/blackfire-php/blackfire-agent_${version}_amd64.deb"; + sha256 = "1p00flipm5x6r36gblfrfrd14byipilybrhfzv8rzpahz2b7r5hb"; + }; + + nativeBuildInputs = [ + dpkg + autoPatchelfHook + ]; + + dontUnpack = true; + + installPhase = '' + runHook preInstall + + dpkg-deb -x $src $out + mv $out/usr/* $out + rmdir $out/usr + + runHook postInstall + ''; + + passthru = { + updateScript = writeShellScript "update-${pname}" '' + export PATH="${lib.makeBinPath [ curl jq common-updater-scripts ]}" + update-source-version "$UPDATE_NIX_ATTR_PATH" "$(curl https://blackfire.io/api/v1/releases | jq .agent --raw-output)" + ''; + }; + + meta = with lib; { + description = "Blackfire Profiler agent and client"; + homepage = "https://blackfire.io/"; + license = licenses.unfree; + maintainers = with maintainers; [ jtojnar ]; + platforms = [ "x86_64-linux" ]; + }; +} diff --git a/pkgs/development/tools/misc/blackfire/php-probe.nix b/pkgs/development/tools/misc/blackfire/php-probe.nix new file mode 100644 index 000000000000..5de2a05349a6 --- /dev/null +++ b/pkgs/development/tools/misc/blackfire/php-probe.nix @@ -0,0 +1,63 @@ +{ stdenv +, lib +, fetchurl +, dpkg +, autoPatchelfHook +, php +, writeShellScript +, curl +, jq +, common-updater-scripts +}: + +let + soFile = { + "7.3" = "blackfire-20180731"; + "7.4" = "blackfire-20190902"; + }.${lib.versions.majorMinor php.version} or (throw "Unsupported PHP version."); +in stdenv.mkDerivation rec { + pname = "php-blackfire"; + version = "1.41.0"; + + src = fetchurl { + url = "https://packages.blackfire.io/debian/pool/any/main/b/blackfire-php/blackfire-php_${version}_amd64.deb"; + sha256 = "0vbl48bccswk9ygb4sshn24cl33fk0xg8d1bcg7ihvdc45any9ww"; + }; + + nativeBuildInputs = [ + dpkg + autoPatchelfHook + ]; + + unpackPhase = '' + runHook preUnpack + + dpkg-deb -x $src pkg + sourceRoot=pkg + + runHook postUnpack + ''; + + installPhase = '' + runHook preInstall + + install -D usr/lib/blackfire-php/amd64/${soFile}${lib.optionalString php.ztsSupport "-zts"}.so $out/lib/php/extensions/blackfire.so + + runHook postInstall + ''; + + passthru = { + updateScript = writeShellScript "update-${pname}" '' + export PATH="${lib.makeBinPath [ curl jq common-updater-scripts ]}" + update-source-version "$UPDATE_NIX_ATTR_PATH" "$(curl https://blackfire.io/api/v1/releases | jq .probe.php --raw-output)" + ''; + }; + + meta = with lib; { + description = "Blackfire Profiler PHP module"; + homepage = "https://blackfire.io/"; + license = licenses.unfree; + maintainers = with maintainers; [ jtojnar ]; + platforms = [ "x86_64-linux" ]; + }; +} diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 6e82c538c694..ab0a1cf5c2f5 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -10679,6 +10679,8 @@ in black = with python3Packages; toPythonApplication black; + blackfire = callPackage ../development/tools/misc/blackfire { }; + black-macchiato = with python3Packages; toPythonApplication black-macchiato; blackmagic = callPackage ../development/tools/misc/blackmagic { }; diff --git a/pkgs/top-level/php-packages.nix b/pkgs/top-level/php-packages.nix index 8f052ee87b8c..1e915f93851f 100644 --- a/pkgs/top-level/php-packages.nix +++ b/pkgs/top-level/php-packages.nix @@ -399,6 +399,8 @@ in meta.maintainers = lib.teams.php.members; }; + blackfire = pkgs.callPackage ../development/tools/misc/blackfire/php-probe.nix { inherit php; }; + couchbase = buildPecl rec { version = "2.6.1"; pname = "couchbase";