example: running instrumentation for logging

bcoe · bcoe · commit 6e01042dd45b · 2026-06-27T11:44:52.000-04:00
diff --git a/frontend/src/store/index.js b/frontend/src/store/index.js
@@ -1,4 +1,5 @@
 import { createStore } from 'vuex'
+import * as Sentry from '@sentry/vue'
 import api from '@/api'
 import helper from '@/helper'
 
@@ -46,7 +47,10 @@ const store = createStore({
                 const response = await api.get('user')
                 commit('SET_USER', response.data)
             } catch (error) {
-                console.error(error)
+                Sentry.logger.error('Failed to load authenticated user', {
+                    'gibpotato.api.endpoint': 'user',
+                    'gibpotato.api.status_code': error.response?.status,
+                })
             }
         },
         async getUsers({ commit }) {
@@ -84,25 +88,34 @@ const store = createStore({
         async toggleSentNotifications({ commit, getters }) {
             commit('TOGGLE_SENT_NOTIFICATIONS')
             try {
-                const response = await api.patch('user', getters.user)
+                await api.patch('user', getters.user)
             } catch (error) {
-                console.error(error)
+                Sentry.logger.warn('Notification preference may not have persisted', {
+                    'gibpotato.settings.notification_type': 'sent',
+                    'gibpotato.api.status_code': error.response?.status,
+                })
             }
         },
         async toggleReceivedNotifications({ commit, getters }) {
             commit('TOGGLE_RECEIVED_NOTIFICATIONS')
             try {
-                const response = await api.patch('user', getters.user)
+                await api.patch('user', getters.user)
             } catch (error) {
-                console.error(error)
+                Sentry.logger.warn('Notification preference may not have persisted', {
+                    'gibpotato.settings.notification_type': 'received',
+                    'gibpotato.api.status_code': error.response?.status,
+                })
             }
         },
         async toggleTooGoodToGoNotifications({ commit, getters }) {
             commit('TOGGLE_TOO_GOOD_TO_GO_NOTIFICATIONS')
             try {
-                const response = await api.patch('user', getters.user)
+                await api.patch('user', getters.user)
             } catch (error) {
-                console.error(error)
+                Sentry.logger.warn('Notification preference may not have persisted', {
+                    'gibpotato.settings.notification_type': 'too_good_to_go',
+                    'gibpotato.api.status_code': error.response?.status,
+                })
             }
         },
         setRangeFilter({ commit }, range) {
diff --git a/frontend/src/views/Shop.vue b/frontend/src/views/Shop.vue
@@ -204,6 +204,8 @@
 import { computed } from 'vue'
 import { useStore } from 'vuex'
 
+import * as Sentry from '@sentry/vue'
+
 import api from '@/api'
 
 import 'vue-select/dist/vue-select.css';
@@ -273,11 +275,21 @@ export default {
                 this.purchaseSuccess = true
                 this.code = response.data.code
 
+                Sentry.logger.info('Shop purchase completed', {
+                    'gibpotato.shop.product_id': this.product.id,
+                    'gibpotato.shop.purchase_mode': this.purchaseMode,
+                    'gibpotato.shop.is_gift': this.purchaseMode !== 'myself',
+                })
+
                 await this.$store.dispatch('getUser')
                 await this.$store.dispatch('getProducts')
                 await this.$store.dispatch('getCollection')
             } catch (error) {
-                console.log(error)
+                Sentry.logger.warn('Shop purchase failed', {
+                    'gibpotato.shop.product_id': this.product?.id,
+                    'gibpotato.shop.purchase_mode': this.purchaseMode,
+                    'gibpotato.shop.status_code': error.response?.status,
+                })
                 this.modalError = error.response.data.error
             } finally {
                 this.loading = false
diff --git a/potal/handler.go b/potal/handler.go
@@ -166,6 +166,13 @@ func (h *Handler) EventsHandler(w http.ResponseWriter, r *http.Request, _ httpro
 					}
 
 					h.emitEventMetric(txn.Context(), "potal.event.forwarded", "message")
+					slog.InfoContext(txn.Context(), "Potato message forwarded to API",
+						"gibpotato.event.type", "message",
+						"gibpotato.message.sender", processedEvent.Sender,
+						"gibpotato.message.receivers", len(processedEvent.Receivers),
+						"gibpotato.potatoes.amount", processedEvent.Amount,
+						"gibpotato.slack.channel", processedEvent.Channel,
+					)
 					txn.Status = sentry.SpanStatusOK
 				}()
 			}
@@ -200,6 +207,13 @@ func (h *Handler) EventsHandler(w http.ResponseWriter, r *http.Request, _ httpro
 				}
 
 				h.emitEventMetric(txn.Context(), "potal.event.forwarded", "reaction_added")
+				slog.InfoContext(txn.Context(), "Potato reaction forwarded to API",
+					"gibpotato.event.type", "reaction_added",
+					"gibpotato.message.sender", processedEvent.Sender,
+					"gibpotato.message.receivers", len(processedEvent.Receivers),
+					"gibpotato.potatoes.amount", processedEvent.Amount,
+					"gibpotato.slack.channel", processedEvent.Channel,
+				)
 				txn.Status = sentry.SpanStatusOK
 			}()
 		case *slackevents.AppMentionEvent:
diff --git a/shopato/app/controllers/concerns/secure_potato_concern.rb b/shopato/app/controllers/concerns/secure_potato_concern.rb
@@ -4,31 +4,19 @@ module SecurePotatoConcern
   private
 
   def authenticate_🥔!
-    if valid_authentication?
-      Sentry.logger.debug("Authentication successful",
-        request_path: request.path,
-        request_method: request.method)
-    else
-      Sentry.logger.warn("Authentication failed - invalid or missing token",
-        request_path: request.path,
-        request_method: request.method,
-        remote_ip: request.remote_ip)
-      head :unauthorized
-    end
+    return if valid_authentication?
+
+    Sentry.logger.warn("Gift card request authentication failed",
+      "gibpotato.auth.request_path": request.path,
+      "gibpotato.auth.request_method": request.method,
+      "gibpotato.auth.remote_ip": request.remote_ip)
+    head :unauthorized
   end
 
   def valid_authentication?
     token = request.headers["Authorization"]
     return false unless token
 
-    is_valid = token == Rails.application.config.gib_potato_token
-
-    unless is_valid
-      Sentry.logger.debug("Token validation failed",
-        token_present: token.present?,
-        token_length: token&.length)
-    end
-
-    is_valid
+    token == Rails.application.config.gib_potato_token
   end
 end
diff --git a/shopato/app/controllers/gift_card_controller.rb b/shopato/app/controllers/gift_card_controller.rb
@@ -6,8 +6,6 @@ class GiftCardController < ActionController::Base
   skip_forgery_protection
 
   def create
-    log_info("Gift card creation request received", name: params[:name], amount: params[:amount])
-
     gift_card = build_gift_card
 
     if gift_card.valid?
@@ -29,38 +27,19 @@ def build_gift_card
   end
 
   def handle_valid_gift_card(gift_card)
-    log_debug("Gift card validation passed", gift_card_id: gift_card.id, amount: gift_card.amount)
-
     service_result = gift_card_service.create_gift_card(gift_card.amount, gift_card.name)
 
     if service_result[:success]
-      handle_service_success(service_result, gift_card)
+      render json: service_result[:gift_card], status: :created
     else
-      handle_service_failure(service_result, gift_card)
+      render json: {errors: service_result[:message]}, status: :unprocessable_content
     end
   end
 
-  def handle_service_success(result, gift_card)
-    log_info("Gift card created successfully",
-      gift_card_id: result[:gift_card]["id"],
-      amount: result[:gift_card]["amount"],
-      name: gift_card.name)
-    render json: result[:gift_card], status: :created
-  end
-
-  def handle_service_failure(result, gift_card)
-    log_error("Gift card creation failed",
-      error_message: result[:message],
-      name: gift_card.name,
-      amount: gift_card.amount)
-    render json: {errors: result[:message]}, status: :unprocessable_content
-  end
-
   def handle_validation_errors(gift_card)
-    log_warn("Gift card validation failed",
-      errors: gift_card.errors.full_messages,
-      name: gift_card.name,
-      amount: gift_card.amount)
+    log_warn("Gift card request failed validation",
+      "gibpotato.giftcard.amount": gift_card.amount,
+      "gibpotato.giftcard.validation_errors": gift_card.errors.full_messages)
     render json: {errors: gift_card.errors.full_messages}, status: :unprocessable_content
   end
 
diff --git a/shopato/app/services/shopify_gift_card_service.rb b/shopato/app/services/shopify_gift_card_service.rb
@@ -18,11 +18,11 @@ class ShopifyGiftCardService
   def initialize(shop: Rails.application.config.shopify_shop_domain, token: Rails.application.config.shopify_admin_access_token)
     @session = ShopifyAPI::Auth::Session.new(shop: shop, access_token: token)
     @client = ShopifyAPI::Clients::Graphql::Admin.new(session: @session)
-    log_debug("ShopifyGiftCardService initialized", shop: shop)
   end
 
   def create_gift_card(amount, name = nil, note: nil)
-    log_info("Creating gift card via Shopify API", amount: amount, name: name)
+    log_info("Creating gift card via Shopify",
+      "gibpotato.giftcard.amount": amount)
 
     begin
       variables = build_mutation_variables(amount, name, note)
@@ -45,7 +45,6 @@ def build_mutation_variables(amount, name, note)
   end
 
   def execute_graphql_mutation(variables)
-    log_trace("Executing Shopify GraphQL mutation", variables: variables)
     @client.query(query: CREATE_MUTATION, variables: variables)
   end
 
@@ -68,10 +67,9 @@ def extract_user_errors(payload)
   end
 
   def handle_user_errors(errors, amount, name)
-    log_error("Shopify API returned user errors",
-      errors: errors,
-      amount: amount,
-      name: name)
+    log_error("Shopify returned user errors creating gift card",
+      "gibpotato.giftcard.amount": amount,
+      "gibpotato.giftcard.user_errors": errors)
     error!(errors.join(", "))
   end
 
@@ -82,19 +80,18 @@ def build_success_response(payload)
       "code" => payload["giftCardCode"]
     }
 
-    log_info("Gift card created successfully via Shopify",
-      gift_card_id: gift_card_data["id"],
-      amount: gift_card_data["amount"])
+    log_info("Gift card created via Shopify",
+      "gibpotato.giftcard.id": gift_card_data["id"],
+      "gibpotato.giftcard.amount": gift_card_data["amount"])
 
     success!(gift_card: gift_card_data)
   end
 
   def handle_api_error(error, amount, name)
-    log_error("Shopify API error occurred",
-      error_message: error.message,
-      error_class: error.class.name,
-      amount: amount,
-      name: name)
+    log_error("Shopify API request failed",
+      "gibpotato.giftcard.amount": amount,
+      "gibpotato.giftcard.error_class": error.class.name,
+      "gibpotato.giftcard.error_message": error.message)
     error!("Shopify error: #{error.message}")
   end
 
diff --git a/src/Controller/Api/ShopController.php b/src/Controller/Api/ShopController.php
@@ -11,6 +11,7 @@
 use function Cake\Core\env;
 use function Sentry\getBaggage;
 use function Sentry\getTraceparent;
+use function Sentry\logger;
 
 /**
  * @property \Authentication\Controller\Component\AuthenticationComponent $Authentication
@@ -147,6 +148,15 @@ public function purchase(): Response
                 ]);
                 $purchase = $purchasesTable->saveOrFail($purchase);
             } else {
+                logger()->warn(
+                    message: 'Gift card fulfilment failed',
+                    attributes: [
+                        'gibpotato.purchase.id' => $purchase->id,
+                        'gibpotato.shop.product_id' => $product->id,
+                        'gibpotato.api.status_code' => $response->getStatusCode(),
+                    ],
+                );
+
                 return $this->response
                     ->withStatus(500)
                     ->withType('json')
@@ -209,6 +219,17 @@ public function purchase(): Response
             );
         }
 
+        logger()->info(
+            message: 'Shop purchase completed',
+            attributes: [
+                'gibpotato.purchase.id' => $purchase->id,
+                'gibpotato.shop.product_id' => $product->id,
+                'gibpotato.purchase.price' => $product->price,
+                'gibpotato.purchase.is_gift' => $presentee !== null,
+                'gibpotato.purchase.is_gift_card' => $product->type === Product::TYPE_GIFT_CARD,
+            ],
+        );
+
         return $this->response
             ->withStatus(200)
             ->withType('json')
diff --git a/src/Service/AwardService.php b/src/Service/AwardService.php
@@ -85,6 +85,12 @@ private function gibToUser(
                 $toUser->slack_name,
                 $event->amount,
             ],
+            attributes: [
+                'gibpotato.event.type' => $event->type,
+                'gibpotato.potatoes.amount' => $event->amount,
+                'gibpotato.message.sender_id' => $fromUser->id,
+                'gibpotato.message.receiver_id' => $toUser->id,
+            ],
         );
     }
 }
diff --git a/src/Service/ProgressionService.php b/src/Service/ProgressionService.php
@@ -7,6 +7,7 @@
 use App\Model\Entity\Progression;
 use App\Model\Entity\User;
 use Cake\ORM\Locator\LocatorAwareTrait;
+use function Sentry\logger;
 
 class ProgressionService
 {
@@ -44,6 +45,15 @@ public function progress(User $user): void
         ]);
         $usersTable->saveOrFail($user);
 
+        logger()->info(
+            message: 'User progression unlocked',
+            attributes: [
+                'gibpotato.user.id' => $user->id,
+                'gibpotato.progression.id' => $progression->id,
+                'gibpotato.progression.name' => $progression->name,
+            ],
+        );
+
         $this->sendProgressionNotification($user, $progression);
     }
 
diff --git a/src/Service/UserService.php b/src/Service/UserService.php
@@ -10,6 +10,7 @@
 use Cake\ORM\Locator\LocatorAwareTrait;
 use Exception;
 use function Cake\Core\env;
+use function Sentry\logger;
 
 class UserService
 {
@@ -70,6 +71,15 @@ public function getOrCreateUser(string $slackUserId): ?User
 
         $user = $this->Users->saveOrFail($user);
 
+        logger()->info(
+            message: 'New user created',
+            attributes: [
+                'gibpotato.user.id' => $user->id,
+                'gibpotato.user.slack_user_id' => $user->slack_user_id,
+                'gibpotato.user.is_bot' => $user->slack_is_bot,
+            ],
+        );
+
         $this->ApiTokens->generateApiToken($user);
 
         $this->sendWelcomeNotification($user);

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,12 @@ private function gibToUser(`
`85`	`85`	`$toUser->slack_name,`
`86`	`86`	`$event->amount,`
`87`	`87`	`],`
	`88`	`+ attributes: [`
	`89`	`+ 'gibpotato.event.type' => $event->type,`
	`90`	`+ 'gibpotato.potatoes.amount' => $event->amount,`
	`91`	`+ 'gibpotato.message.sender_id' => $fromUser->id,`
	`92`	`+ 'gibpotato.message.receiver_id' => $toUser->id,`
	`93`	`+ ],`
`88`	`94`	`);`
`89`	`95`	`}`
`90`	`96`	`}`