Project

General

Profile

Actions
Copy link

Bug #22781

closed

Diagnostics endpoint checks should name the service they're checking

Added by Brett Smith 12 months ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Brett Smith
Category:
Deployment
Target version:
Development 2025-04-30
Story points:
-
Release:
Arvados 3.2.0
Release relationship:
Auto

Description

This code in source:lib/diagnostics/cmd.go:

for i, svc := range []*arvados.Service{
    &cluster.Services.Keepproxy,
    &cluster.Services.WebDAV,
    &cluster.Services.WebDAVDownload,
    &cluster.Services.Websocket,
    &cluster.Services.Workbench1,
    &cluster.Services.Workbench2,
} {
    diag.dotest(40+i, fmt.Sprintf("connecting to service endpoint %s", svc.ExternalURL), func() error {

The "connecting to service" message should name the service it's checking alongside the URL. This would make it easier to spot mistakes where someone has assigned a meaningful URL to the service, but it's the wrong URL for that particular service.

Subtasks 1 (0 open — 1 closed)

Task #22789: Review 22781-name-endpointsResolvedBrett Smith04/16/2025Actions
Actions
Copy link
 #1

Updated by Brett Smith 11 months ago

  • Target version set to Development 2025-04-16
  • Assigned To set to Brett Smith
  • Status changed from New to In Progress
Actions
Copy link
 #2

Updated by Brett Smith 11 months ago

22781-name-endpoints @ f6985add9a5c4cf2a71ed80a788d17f775b96d8f - developer-run-tests: #4733

  • All agreed upon points are implemented / addressed.
    • Yes
  • Anything not implemented (discovered or discussed during work) has a follow-up story.
    • N/A
  • Code is tested and passing, both automated and manual, what manual testing was done is described
    • See above, also tested manually to confirm the output looked as expected and did not change test IDs
  • Documentation has been updated.
    • N/A
  • Behaves appropriately at the intended scale (describe intended scale).
    • N/A
  • Considered backwards and forwards compatibility issues between client and server.
    • N/A
  • Follows our coding standards and GUI style guidelines.
    • Yes
Actions
Copy link
 #3

Updated by Brett Smith 11 months ago

  • Subtask #22789 added
Actions
Copy link
 #4

Updated by Tom Clegg 11 months ago

Nit: now the services aren't numbered/checked in a defined order. If that's worth preserving, you could do

for i, ent := range []struct{svcName string; svc *arvados.Service}{
       {"Keepproxy", &cluster.Services.Keepproxy},

Other than that, LGTM

Actions
Copy link
 #5

Updated by Brett Smith 11 months ago

Tom Clegg wrote in #note-4:

Nit: now the services aren't numbered/checked in a defined order. If that's worth preserving, you could do [code] Other than that, LGTM

A defined order seems worth preserving for consistency across runs. As an admin I wouldn't want to have the results shuffled on me.

This ended up touching a little more than I expected so now at f4c16053d7 for another look.

Actions
Copy link
 #6

Updated by Peter Amstutz 11 months ago

  • Target version changed from Development 2025-04-16 to Development 2025-04-30
Actions
Copy link
 #7

Updated by Tom Clegg 11 months ago

LGTM, thanks.

Actions
Copy link
 #8

Updated by Brett Smith 11 months ago

  • Status changed from In Progress to Resolved
Actions
Copy link
 #9

Updated by Brett Smith 6 months ago

  • Release set to 79
Actions
Copy link

Also available in: Atom PDF