Help?

[YouveGotMeowxy]

I can't seem to get AutoKuma (AK) to add my services to UptimeKuma (UK). Can anyone point out what I'm messing up? For the record, I'm running Swarm.

My AK compose

  autokuma:
    hostname: 'autokuma'
    image: 'ghcr.io/bigboot/autokuma:latest'
    environment: 
      RUST_LOG: 'kuma_client=debug,autokuma=debug'
    volumes:
      - '/opt/docker/configs/autokuma/data:/data'
      - '/opt/docker/configs/autokuma/autokuma.toml:/autokuma.toml:ro'
      - '/var/run/docker.sock:/var/run/docker.sock:ro'
    deploy:
      mode: 'replicated'
      replicas: 1
      labels:
        com.ouroboros.enable: 'true'
      resources:
        limits:
          memory: '100M'
      placement:
        constraints:
          - 'node.labels.Cloud == true'
      restart_policy:
        condition: 'any'

My autokuma.toml

[kuma]

    # UptimeKuma Creds
    url                 = "http://uptimekuma:3001"
    username            = "Me"
    password            = "blah"

    # AutoKuma Settings
    docker.label_prefix = "autokuma"
    docker.source       = "Both"
    static_monitors     = "/data/static"
    log_dir             = "/data/logs"
    docker.hosts        = "unix:///var/run/docker.sock"

[snippets]

    htpc = '''
        htpc.group.name: 'HTPC'
        htpc.group.description: 'Home Theater'
        {{ container_name }}_http.http.active:         'true'
        {{ container_name }}_http.http.parent_name:    'htpc'
        {{ container_name }}_http.http.name:           '{{ container_name | capitalize }}'
        {{ container_name }}_http.http.description:    '{{ args[0] }}'
        {{ container_name }}_http.http.url:            'https://{{ container_name | lower }}.domain.com'
        {{ container_name }}_http.http.method:         'GET'
        {{ container_name }}_http.http.interval:       '60'
        {{ container_name }}_http.http.max_retries:    '1'
        {{ container_name }}_http.http.retry_interval: '60'
        {{ container_name }}_http.http.timeout:        '48'
        {{ container_name }}_http.http.max_redirects:  '0'
    '''

Service label on some services

autokuma.__htpc: 'Media Search & Add'

I add all that stuff and restart my AK and the services with those labels and then check UK... nothing.

What's wrong?

[YouveGotMeowxy]

Anyone? Anyone? Bueller?

Bueller?

Anyone?

[YouveGotMeowxy]

Still fighting with this! I tried to switch the snippet to this since I'm using swarm:

[kuma]

    url                 = "http://uptimekuma:3001"
    username            = "myname"
    password            = "pw"
    docker.label_prefix = "autokuma"
    docker.source       = "Both"
    static_monitors     = "/data/static"
    log_dir             = "/data/logs"
    docker.hosts        = "unix:///var/run/docker.sock"

[snippets]

    htpc = '''
        {{ service }}.http.active:         'true'
        {{ service }}.http.parent_name:    'htpc'
        {{ service }}.http.name:           '{{ service | capitalize }}'
        {{ service }}.http.description:    '{{ args[0] }}'
        {{ service }}.http.url:            'https://{{ service | lower }}.mydomain.com'
        {{ service }}.http.method:         'GET'
        {{ service }}.http.interval:       '60'
        {{ service }}.http.max_retries:    '1'
        {{ service }}.http.retry_interval: '60'
        {{ service }}.http.timeout:        '48'
        {{ service }}.http.max_redirects:  '0'
    '''

still nothing gets added to UK. I tested to be sure that the .toml is in fact being read by AK, by changing the pw to something bad and I do get an error connecting to UK, so it is being read; just the snippet won't work.

Is this project dead? Am I wasting my time fighting with this? Anyone? Bueller? @BigBoot ? Anyone?

[BigBoot]

You haven't posted a yaml of one of your actual services you want autokuma to inspect. With swarm mode you can work either of containers or services, depending on where you place labels, I'm assuming you want to work of the service here, so you have something like this in your compose:

services:
  myservice:
    image: myimage
    deploy:
      labels:
        autokuma.__htpc: 'Media Search & Add'

You're snippet could then look something like this (You get access to the whole service object as returned by the Docker API):

[snippets]
    htpc = '''
        {% set service_name = service.Spec.Name %}
        {% set id = service_name | slugify %}

        {{ id }}.http.active:         'true'
        {{ id }}.http.parent_name:    'htpc'
        {{ id }}.http.name:           '{{ service_name | capitalize }}'
        {{ id }}.http.description:    '{{ args[0] }}'
        {{ id }}.http.url:            'https://{{ service_name | lower }}.mydomain.com'
        {{ id }}.http.method:         'GET'
        {{ id }}.http.interval:       '60'
        {{ id }}.http.max_retries:    '1'
        {{ id }}.http.retry_interval: '60'
        {{ id }}.http.timeout:        '48'
        {{ id }}.http.max_redirects:  '0'
    '''

Besides that please also post the AutoKuma output in case you have further issues.

And finally as noted in the Readme, I don't actively use the Swarm (and Kubernetes) source, that doesn't mean they don't work, but I don't have a lot of experience with them.

[YouveGotMeowxy]

ty @BigBoot

That's all pretty much where I'm already at code-wise and still no luck. Here's my current stuff:

snippet:

    htpc = '''
        {% set svc = service.Spec.Name %}
        {% set idslug = svc | slugify %}

        htpc.group.name:        'HTPC'
        htpc.group.description: 'Home Theater'

        {{ idslug }}.http.active:         'true'
        {{ idslug }}.http.parent_name:    'htpc'
        {{ idslug }}.http.name:           '{{ svc | capitalize }}'
        {{ idslug }}.http.description:    '{{ args[0] | default(value="") }}'
        {{ idslug }}.http.url:            'https://{{ svc | lower }}.mydomain.com'
        {{ idslug }}.http.method:         'GET'
        {{ idslug }}.http.interval:       '60'
        {{ idslug }}.http.max_retries:    '1'
        {{ idslug }}.http.retry_interval: '60'
        {{ idslug }}.http.timeout:        '48'
        {{ idslug }}.http.max_redirects:  '0'
    '''

I also had tried switching the AK label from being a service label to a container label but on the service, and then tried this snippet as tweaked for me by Grok:

    htpc = '''
        {% set svc = container["Config"]["Labels"]["com.docker.swarm.service.name"]
                    | default(container["Name"] | split(".") | first | default("unknown")) %}
        {% set idslug = svc | slugify %}

        htpc.group.name:        'HTPC'
        htpc.group.description: 'Home Theater'

        {{ idslug }}.http.active:         'true'
        {{ idslug }}.http.parent_name:    'htpc'
        {{ idslug }}.http.name:           '{{ svc | capitalize }}'
        {{ idslug }}.http.description:    '{{ args[0] | default(value="") }}'
        {{ idslug }}.http.url:            'https://{{ svc | lower }}.mydomain.com'
        {{ idslug }}.http.method:         'GET'
        {{ idslug }}.http.interval:       '60'
        {{ idslug }}.http.max_retries:    '1'
        {{ idslug }}.http.retry_interval: '60'
        {{ idslug }}.http.timeout:        '48'
        {{ idslug }}.http.max_redirects:  '0'
    '''

but still neither worked, whether using an actual service label on the service, or as a container label on the service.

An example service using it is basically exactly like the AK yaml I originally gave, and then including the service label I also originally gave. For example:

  overseerr:
    hostname: 'overseerr'
    image: 'ghcr.io/hotio/overseerr:release'
    environment:
      TZ: 'America/Chicago'
      PUID: '1000'
      PGID: '1000'
    volumes:
      - '/opt/docker/configs/overseerr/config:/config'
      - '/mnt/e/Docker/Logs/overseerr:/config/Logs'
    networks:
      - 'htpc'
      - 'web'
    deploy:
      mode: 'replicated'
      replicas: 1
      labels:
        autokuma.__htpc: "Media Search & Add"
        com.ouroboros.enable: 'true'
      placement:
        constraints:
          - 'node.labels.myplaceCloud == true'
      resources:
        limits:
          memory: '350M'
      restart_policy:
        condition: 'any'

I'm afraid I don't have anything to paste as far as AK logs, because it just shows this:

I've also tried changing the log output levels to for example:

RUST_LOG: 'kuma_client=trace,autokuma=trace'

(or debug instead of trace)

and it just kinda spams the log with reads from UK, getting tag info and such, but nothing ever as far as AK trying to read from labels and failing, or anything of the like.

[YouveGotMeowxy]

Also, quick side question: is there already a Kuma CLI built-in to the AK container that can be used? If not, wouldn't it be helpful to add it to the container for us?

While wrestling with all this I had to use it and did try in the container but got nothing, so had to go through the process of installing it (had to install cargo first, configure the new file, etc.). It would've been much quicker n easier if there were already one in the container that read from the autokuma.toml I could've just popped in and used. :)