GASのPropertiesServiceを使ったお手軽外形監視

GAS
properties-service

11ヶ月前
3 min read

Google Apps Scriptで、関数のコンピューティング時以外もサーバー側にデータを永続化する仕組み（PropertiesService）がある事を知り応用の幅が広がったため、備忘録として。

以下は、2025年6月時点での仕様。

PropertiesServiceとは

Key-Value ペア形式のシンプルなデータを保存可能
3つのプロパティストレージがあり、スコープが異なる
プロパティストレージに保存されたデータはスクリプトが実行終了しても消えない
永続容量制限は約 500KB / 1スクリプト

ScriptProperties（スクリプトプロパティ）

1
PropertiesService.getScriptProperties();

スコープ（保存先）: スクリプト全体（GASプロジェクト）
共有範囲: そのスクリプトにアクセス権限を持つ全てのユーザー間で共有

UserProperties（ユーザープロパティ）

1
PropertiesService.getUserProperties();

スコープ: 実行しているユーザー固有
共有範囲: 同じユーザーのみ（他のユーザーからはアクセス不可）

DocumentProperties（ドキュメントプロパティ）

1
PropertiesService.getDocumentProperties();

スコープ: 特定のドキュメント（スプレッドシート、ドキュメント、スライドなど）
共有範囲: そのドキュメントにアクセスできる全てのユーザー間で共有

お手軽な外形監視として使う場合

要件次第では、ちょっとした外形監視をするのに便利な仕組み。
例えば、特定のURLに定期的にアクセスして、レスポンスが200 OKであることを確認するようなスクリプトを書くことができる。

下記は、検出のためのサンプルコード。

1
// 監視したいWebサイトのURLリスト
2
const TARGET_LIST = [
3
  { id: '200_sample', url: 'https://httpstat.us/200' },
4
  { id: '400_sample', url: 'https://httpstat.us/400' },
5
  { id: '500_sample', url: 'https://httpstat.us/500' }
6
]
7

8
const CONFIG = {
9
  SLACK_WEBHOOK_URL:
10
    'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX',
11
  SLACK_CHANNEL: '#channel-name',
12
  PROPERTY_KEY_PREFIX: 'WEBSITE_STATUS_',
13
  SLOW_RESPONSE_THRESHOLD: 3000
14
}
15

16
function getPropertyKeyById (id) {
17
  const { PROPERTY_KEY_PREFIX } = CONFIG
18
  return PROPERTY_KEY_PREFIX + id
19
}
20

21
/**
22
 * ウェブサイトを監視する
23
 */
24
function monitorWebsites () {
25
  // スクリプトプロパティを取得
26
  const propertyStore = PropertiesService.getScriptProperties()
27

28
  TARGET_LIST.forEach(site => {
29
    const statusKey = getPropertyKeyById(site.id)
30
    const prevStatus = propertyStore.getProperty(statusKey)
31

32
    try {
33
      const startTime = Date.now()
34
      // GAS組み込みmethodである、UrlFetchApp.fetch を使い、外部のAPIやウェブサイトにHTTP,HTTPSリクエストを送る
35
      // @see https://developers.google.com/apps-script/reference/url-fetch/url-fetch-app?hl=ja
36
      const response = UrlFetchApp.fetch(site.url, {
37
        muteHttpExceptions: true,
38
        followRedirects: true,
39
        validateHttpsCertificates: true
40
      })
41
      const endTime = Date.now()
42

43
      const responseTime = endTime - startTime
44
      const responseCode = response.getResponseCode()
45
      const isSuccess = responseCode >= 200 && responseCode < 400
46

47
      if (prevStatus === null) {
48
        if (!isSuccess) {
49
          // Slackに通知するなど
50
        }
51
        // 現在のステータスを保存
52
        propertyStore.setProperty(statusKey, String(isSuccess))
53
      } else {
54
        const prevIsSuccess = prevStatus === 'true'
55

56
        if (prevIsSuccess && !isSuccess) {
57
          // ダウンの場合
58
          propertyStore.setProperty(statusKey, String(isSuccess))
59
        } else if (!prevIsSuccess && isSuccess) {
60
          // 復旧した場合
61
          propertyStore.setProperty(statusKey, String(isSuccess))
62
        }
63
      }
64

65
      if (isSuccess && responseTime > CONFIG.SLOW_RESPONSE_THRESHOLD) {
66
        // 応答が遅い場合
67
      }
68
    } catch (error) {
69
      // エラーが発生した場合
70
      if (prevStatus === null || prevStatus !== 'false') {
71
        propertyStore.setProperty(statusKey, 'false')
72
      }
73
    }
74
  })
75
}

サイトごとに正常に判定が得られている事を検証できたら、任意で通知などの実装を行う。

下記は、Slack通知のサンプルコード。

1
function sendSlackNotification (data) {
2
  const { SLACK_WEBHOOK_URL, SLACK_CHANNEL } = CONFIG
3
  const { site, status, responseCode, responseTime, error } = data
4
  const now = new Date()
5

6
  const mentionTypes = {
7
    channel: '<!channel>',
8
    here: '<!here>',
9
    everyone: '<!everyone>'
10
  }
11
  const mentionByStatus = {
12
    down: mentionTypes.channel,
13
    recovered: mentionTypes.channel,
14
    error: mentionTypes.channel
15
  }
16
  const formattedDate = Utilities.formatDate(
17
    now,
18
    'Asia/Tokyo',
19
    'yyyy-MM-dd HH:mm:ss'
20
  )
21
  const messages = {
22
    down: {
23
      text: `*警告* ${site.name} がダウンしています！`,
24
      color: 'danger', // 赤
25
      emoji: ':x:'
26
    },
27
    recovered: {
28
      text: `*復旧* ${site.name} が復旧しました`,
29
      color: 'good', // 緑
30
      emoji: ':white_check_mark:'
31
    },
32
    slow: {
33
      text: `*警告* ${site.name} の応答が遅いです`,
34
      color: 'warning', // 黄色
35
      emoji: ':warning:'
36
    },
37
    error: {
38
      text: `*エラー* ${site.name} の監視中に不明なエラーが発生しました`,
39
      color: 'danger', // 赤
40
      emoji: ':boom:'
41
    }
42
  }
43

44
  const { text, color, emoji } = messages[status]
45

46
  // Slackのメッセージペイロードを作成
47
  const payload = {
48
    channel: SLACK_CHANNEL,
49
    text: mentionByStatus[status] || '',
50
    attachments: []
51
  }
52

53
  const item = {
54
    color: color,
55
    pretext: `${emoji} ${text}`,
56
    title: site.id,
57
    title_link: site.url,
58
    fields: [
59
      {
60
        title: 'URL',
61
        value: site.url,
62
        short: true
63
      },
64
      {
65
        title: 'ステータス',
66
        value: status,
67
        short: true
68
      }
69
    ],
70
    footer: `監視時刻: ${formattedDate}`
71
  }
72

73
  // ステータスに応じた追加情報を設定
74
  if (status === 'down' || status === 'recovered' || status === 'slow') {
75
    item.fields.push(
76
      {
77
        title: 'レスポンスコード',
78
        value: String(responseCode),
79
        short: true
80
      },
81
      {
82
        title: '応答時間',
83
        value: `${responseTime} ms`,
84
        short: true
85
      }
86
    )
87
  } else if (status === 'error') {
88
    item.fields.push({
89
      title: 'エラー詳細',
90
      value: error || '不明なエラー',
91
      short: false
92
    })
93
  }
94

95
  // ペイロードにアタッチメントを追加
96
  payload.attachments.push(item)
97

98
  // SlackのWebhook URLにPOSTリクエストを送信
99
  const options = {
100
    method: 'post',
101
    contentType: 'application/json',
102
    payload: JSON.stringify(payload)
103
  }
104

105
  try {
106
    UrlFetchApp.fetch(SLACK_WEBHOOK_URL, options)
107
  } catch (error) {
108
    Logger.log(`Slack通知の送信に失敗しました: ${error.message}`)
109
  }
110
}

通知が正常に動くことを確認したら、各判定に応じて通知を送るようにmethodを追加しておく。

1
sendSlackNotification({
2
  site,
3
  status: 'down', // 'down', 'recovered', 'slow', 'error'
4
  responseCode,
5
  responseTime,
6
});

まとめ

外形監視ツールとして使う場合、カジュアルな用途が許容されるケースでは、このように状態管理が必要な処理をPropertiesServiceで実装することで、GASのスクリプト実行時以外でも状態を保持し、簡易的な外形監視などの用途にも活用できる。
しっかりした監視が必要な場合は、Zabbixなど体系的な監視システムを利用することをお勧めするが、GASのみでも最低限の処理が実現できる点は大きなメリットだと感じた。