nixos/awstats: refactor module #73959

aristaeus · 2019-11-23T10:57:25Z

Motivation for this change

After some discussion in #72961, I took over as the maintainer for awstats with a mandate to refactor it. The new module is much more flexible, and should cover most use cases.

Things done

Examples

service.awstats = {
  enable = true;
  configs = {
    "basic.com" = {
      logFile = "/path/to/log/file";
      # in this case you can access the stats at basic.com/awstats
    };
    "advancedconfig" = {
      logFile = "/path/to/log/file";
      domain = "foo.com";
      hostAliases = "www.foo.com";
      extraConfig = {
        "ValidHTTPCodes" = "404";
      };
      webService = {
        hostname = "awstats.foo.com";
	urlPrefix = "";
      };
    };
    "mail.com" = {
      type = "mail";
      logFile = "journalctl $OLD_CURSOR -u postfix.service | ${pkgs.perl}/bin/perl ${package.out}/share/awstats/tools/maillogconvert.pl standard |";
      logFormat = "%time2 %email %email_r %host %host_r %method %url %code %bytesd";
    };
  };
  updateAt = "hourly";
};

@griff I haven't tested the mail config but it should mostly work - let me know how you go.

If anyone else can test this too that would be good. @aanderse

aanderse

This looks great! Well done. Just a few minor changes requested. Thanks for your work on this.

nixos/modules/services/logging/awstats.nix

aanderse · 2019-12-06T23:04:55Z

@aristaeus I'd like to move this along so I will probably try to do some testing on this. Can you provide me with a minimal configuration to get this up and running? I have an apache server with 2 domains I can test this on.

aristaeus · 2019-12-07T06:56:33Z

services.awstats = {
  enable = true;
  configs."foobar.com" = {
    logFile = "/path/to/logs/access.log";
    webService = {
      enable = true;
      hostname = "awstats.foobar.com";
      urlPrefix = "/stats";
    };
  };
  updateAt = "minutely";
};

aanderse

I was testing with httpd (I don't run nginx) so I had make a few adjustments in my configuration.nix to match your code.

nixos/modules/services/logging/awstats.nix

aanderse · 2019-12-14T14:40:45Z

@aristaeus ping

aanderse · 2019-12-18T19:18:57Z

@aristaeus all folders under /var/lib/awstats are coming out as 744 with permissions. I think we need 755 or such?

aanderse · 2019-12-22T00:49:09Z

nixos/modules/services/logging/awstats.nix

+          "${opts.webService.urlPrefix}/" = {
+            alias = "${cfg.dataDir}/${name}/";
+            extraConfig = ''
+              autoindex on;


@aristaeus optional suggestion, but it looks like you might want to direct users to awstats.${name}.html instead of a directory listing here.

aanderse

@aristaeus you should also add an entry to the release notes. You can advertise your great work here!

nixos/modules/services/logging/awstats.nix

ArdaXi · 2019-12-25T09:24:12Z

I haven't quite figured out why this happens yet but this change seems to have broken builds of the manual for me:

<3>
<3>manual-combined.xml:74241: element link: validity error : IDREF attribute linkend references an unknown ID "opt-services.httpd"
<3> 74237     <listitem>
<3> 74238      <para>
<3> 74239       The <link linkend="opt-services.awstats">awstats</link> module has been rewritten
<3> 74240       to serve stats via static html pages, updated on a timer, over <link linkend="opt-services.nginx.virtualHosts">nginx</link>,
<3> 74241       instead of dynamic cgi pages over <link linkend="opt-services.httpd">apache</link>.
<3> 74242      </para>
<3> 74243      <para>
<3>
<3>manual-combined.xml:74239: element link: validity error : IDREF attribute linkend references an unknown ID "opt-services.awstats"
<3> 74235      </itemizedlist>
<3> 74236     </listitem>
<3> 74237     <listitem>
<3> 74238      <para>
<3> 74239       The <link linkend="opt-services.awstats">awstats</link> module has been rewritten
<3> 74240       to serve stats via static html pages, updated on a timer, over <link linkend="opt-services.nginx.virtualHosts">nginx</link>,
<3> 74241       instead of dynamic cgi pages over <link linkend="opt-services.httpd">apache</link>.
<3>
<3>manual-combined.xml:74245: element link: validity error : IDREF attribute linkend references an unknown ID "opt-services.awstats"
<3> 74241       instead of dynamic cgi pages over <link linkend="opt-services.httpd">apache</link>.
<3> 74242      </para>
<3> 74243      <para>
<3> 74244       Minor changes will be required to migrate existing configurations. Details of the
<3> 74245       required changes can seen by looking through the <link linkend="opt-services.awstats">awstats</link>
<3> 74246       module.
<3> 74247      </para>
<3>
<3>manual-combined.xml fails to validate
<3>builder for '/nix/store/cz0hj40312p7ajf88ii2hvc5p1kmgfz1-nixos-manual-combined.drv' failed with exit code 3

I can dig into this more after the holidays, but I wanted to put this here so I know where to look and in case someone else can already see what's happening.

danbst · 2019-12-25T19:12:15Z

@ArdaXi fixed

ofborg bot added 6.topic: nixos 8.has: module (update) 10.rebuild-darwin: 0 10.rebuild-linux: 0 labels Nov 23, 2019

aanderse requested changes Nov 23, 2019

View reviewed changes

aanderse requested changes Dec 7, 2019

View reviewed changes

nixos/modules/services/logging/awstats.nix Outdated Show resolved Hide resolved

nixos/modules/services/logging/awstats.nix Outdated Show resolved Hide resolved

aanderse reviewed Dec 22, 2019

View reviewed changes

aanderse requested changes Dec 22, 2019

View reviewed changes

nixos/modules/services/logging/awstats.nix Outdated Show resolved Hide resolved

aanderse force-pushed the awstats branch from f93cbc6 to 4def9ec Compare December 24, 2019 17:08

ofborg bot added 8.has: changelog 8.has: documentation labels Dec 24, 2019

nixos/awstats: refactor module

dade94c

aanderse force-pushed the awstats branch from 4def9ec to dade94c Compare December 24, 2019 17:22

aanderse approved these changes Dec 24, 2019

View reviewed changes

aanderse changed the title ~~refactor awstats module~~ nixos/awstatsrefactor awstats module Dec 24, 2019

aanderse changed the title ~~nixos/awstatsrefactor awstats module~~ nixos/awstats: refactor module Dec 24, 2019

aanderse merged commit 08bd639 into NixOS:master Dec 24, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/awstats: refactor module #73959

nixos/awstats: refactor module #73959

aristaeus commented Nov 23, 2019

aanderse left a comment

aanderse commented Dec 6, 2019

aristaeus commented Dec 7, 2019

aanderse left a comment

aanderse commented Dec 14, 2019

aanderse commented Dec 18, 2019 •

edited

aanderse Dec 22, 2019

aanderse left a comment

ArdaXi commented Dec 25, 2019

danbst commented Dec 25, 2019

nixos/awstats: refactor module #73959

nixos/awstats: refactor module #73959

Conversation

aristaeus commented Nov 23, 2019

Motivation for this change

Things done

Examples

aanderse left a comment

Choose a reason for hiding this comment

aanderse commented Dec 6, 2019

aristaeus commented Dec 7, 2019

aanderse left a comment

Choose a reason for hiding this comment

aanderse commented Dec 14, 2019

aanderse commented Dec 18, 2019 • edited

aanderse Dec 22, 2019

Choose a reason for hiding this comment

aanderse left a comment

Choose a reason for hiding this comment

ArdaXi commented Dec 25, 2019

danbst commented Dec 25, 2019

aanderse commented Dec 18, 2019 •

edited