pkgs/tools/misc/opentelemetry-collector/contrib.nix

   1 { buildGoModule
   2 , fetchFromGitHub
   3 , lib
   4 , stdenv
   5 , systemdMinimal
   6 , withSystemd ? false
   7 }:
   8
   9 buildGoModule rec {
  10   pname = "opentelemetry-collector-contrib";
  11   version = "0.109.0";
  12
  13   src = fetchFromGitHub {
  14     owner = "open-telemetry";
  15     repo = "opentelemetry-collector-contrib";
  16     rev = "v${version}";
  17     hash = "sha256-ROAapCGIRD5kdA3k1LjSxdfICLRgBcQORe6wW1bszNI=";
  18   };
  19
  20   # proxy vendor to avoid hash mismatches between linux and macOS
  21   proxyVendor = true;
  22   vendorHash = "sha256-4MRXwp428d9oJPHrgOaGCaIFpRAIOpL/AYc/fLPAVBk=";
  23
  24   # there is a nested go.mod
  25   sourceRoot = "${src.name}/cmd/otelcontribcol";
  26
  27   # upstream strongly recommends disabling CGO
  28   # additionally dependencies have had issues when GCO was enabled that weren't caught upstream
  29   # https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md#using-cgo
  30   CGO_ENABLED = 0;
  31
  32   # journalctl is required in-$PATH for the journald receiver tests.
  33   nativeCheckInputs = lib.optionals stdenv.hostPlatform.isLinux [ systemdMinimal ];
  34
  35   # We don't inject the package into propagatedBuildInputs unless
  36   # asked to avoid hard-requiring a large package. For the journald
  37   # receiver to work, journalctl will need to be available in-$PATH,
  38   # so expose this as an option for those who want more control over
  39   # it instead of trusting the global $PATH.
  40   propagatedBuildInputs = lib.optionals withSystemd [ systemdMinimal ];
  41
  42   doCheck = false;
  43
  44   ldflags = [
  45     "-s"
  46     "-w"
  47     "-X github.com/open-telemetry/opentelemetry-collector-contrib/internal/version.Version=v${version}"
  48   ];
  49
  50   meta = with lib; {
  51     description = "OpenTelemetry Collector superset with additional community collectors";
  52     longDescription = ''
  53       The OpenTelemetry Collector offers a vendor-agnostic implementation on how
  54       to receive, process and export telemetry data. In addition, it removes the
  55       need to run, operate and maintain multiple agents/collectors in order to
  56       support open-source telemetry data formats (e.g. Jaeger, Prometheus, etc.)
  57       sending to multiple open-source or commercial back-ends. The Contrib
  58       edition provides aditional vendor specific receivers/exporters and/or
  59       components that are only useful to a relatively small number of users and
  60       is multiple times larger as a result.
  61     '';
  62     homepage = "https://github.com/open-telemetry/opentelemetry-collector-contrib";
  63     changelog = "https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v${version}/CHANGELOG.md";
  64     license = licenses.asl20;
  65     maintainers = with maintainers; [ uri-canva jk ];
  66     mainProgram = "otelcontribcol";
  67   };
  68 }