[How-to] Crafty Controller (Minecraft) widget using customapi

[mgrimace]

With much help from their discord, I've been able to put together a Crafty widget. Note the requirements and limitations below.

    - Crafty:
        icon: https://docs.craftycontrol.com/img/favicon.ico
        href: https://{{HOMEPAGE_VAR_CRAFTY_IP}}:8443 #this will be your crafty IP if you don't use secrets
        widget:
            type: customapi
            url: https://{{HOMEPAGE_VAR_CRAFTY_IP}}:8443/api/v2/servers/1/stats # in this line /1/ is the server ID, if you have multiple servers, you can change this number to a specific server of your choice
            refreshInterval: 10000 
            method: GET 
            headers: 
                Authorization: Bearer {{HOMEPAGE_VAR_CRAFTY_TOKEN}} #this will be your API token that you generate within the webUI
            mappings:
              - field: status 
                label: Status
                format: text 
              - field: 
                   data: online
                label: players
                format: number
              - field: 
                   data: cpu
                label: CPU
                format: percent
              - field: 
                   data: mem_percent
                label: RAM
                format: percent

Requirements

Requires an API token. In the Crafty webUI click the settings gear, find your user (e.g., admin), then click the pencil edit icon for the user. Click the API key tab. For some reason, it requires superuser to be selected. Accordingly, consider using a secret as I did above.

Limitations

Only shows stats for a single, specific server, designated by the ID number in the path, 1 in my example above. If you have multiple crafty servers, you'd have to make additional widgets, changing this path.

Other Possible Fields

Anything under: https://wiki.craftycontrol.com/en/4/docs/API%20V2#get-a-server-s-statistics is fair game. Here's a few that might be useful to swap in (untested):

             - field:
                 data:
                   server_id: server_name #name of the current server specified by the ID# in the path
                label: name
                format: text
             - field:
                 data:
                   server_id: server_ip #ip address of the current server
                label: IP
                format: number
             - field:
                 data:
                   server_id: server_port #port for the current server
                label: PORT
                format: number                                
             - field:
                 data:
                   server_id: type #e.g., minecraft-bedrock
                 label: type
                 format: text  
             - field: 
                   data: online #number of players online
                label: players
                format: number
              - field: 
                   data: cpu
                label: CPU
                format: percent
              - field: 
                   data: mem_percent
                label: RAM
                format: percent
              - field: 
                   data: running
                label: running
                format: text

Closes: #1312

[mgrimace]

As a quick follow-up I submitted an issure re. the limitations to the crafty gitlab: https://gitlab.com/crafty-controller/crafty-4/-/issues/283. Ideally, we won't need a superuser token, and can present 'overall' stats rather than per server.

[mgrimace]

Updated with whole-server stats, and because the server_ID switched from number to UUID and AFAIK the hyphens in the UUID break the widget (http error)

    - Crafty Controller: 
        icon: https://docs.craftycontrol.com/img/favicon.ico
        href: https://crafty.{{HOMEPAGE_VAR_DOMAIN}}:8443
        ping: https://crafty.{{HOMEPAGE_VAR_DOMAIN}}:8443
        widget:
            type: customapi
            url: https://crafty.{{HOMEPAGE_VAR_DOMAIN}}:8443/api/v2/crafty/stats
            refreshInterval: 10000
            method: GET
            headers:
                Authorization: Bearer {{HOMEPAGE_VAR_CRAFTY_TOKEN}}
            mappings:
              - field: status
                label: Status
                format: text
              - field:
                   data: cpu_usage
                label: CPU
                format: percent
              - field:
                   data: mem_percent
                label: RAM
                format: percent
              - field:
                   data: mem_usage
                label: RAM
                format: text
                suffix: "/24GB"

[VanGoghComplex]

Hi! I was using your widget when the update broke it, and am trying to update it per this comment, but I don't quite understand {{HOMEPAGE_VAR_DOMAIN}}. Is this where the UUID of the server I'm monitoring goes?

[mgrimace]

Hi, for url: you would use your crafty IP:8443 or if you use a reverse proxy then crafty.yourdomain.com:8443. I use ‘secrets’ where I define these in a .env file and then use these {{HOMEPAGE_VAR_…}} to keep my personal domains, IPs, tokens, etc. a secret.

You don’t need to use the new UUID if you want the ‘overall’ system stats, which I have above since the update. However, If you do want a specific instance stats, then you can use https://[IP or domain]:8443/api/v2/servers/[SERVER UUID]/stats and whatever fields you want (or the same as the initial instructions if you want to keep things the same)

[VanGoghComplex]

Perfect, just needed to replace the old server ID number with the UUID and it started working again. Thanks for the help!

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.