lookerbot下載 - lookerbot原始碼下載

lookerbot

Ai源碼

0.0.15

下載

觀客機器人

Lookerbot 整合了 Slack 和 Looker，讓您的所有資料觸手可及。

借助 Lookerbot，公司中的每個人都可以輕鬆共享資料並立即回答問題。 Lookerbot 可以回答問題、發送警報等等！

如需免費試用 Looker，請造訪looker.com/free-Trial。

特徵

有關如何與 Lookerbot 交互的詳細信息，請訪問 Looker 幫助中心。

要求

Looker 4.12 或更高版本
能夠運行 Node.js 應用程式以將機器人應用程式部署到的 Web 伺服器
- 需要 Node.js 6.10.3
- 需要紗線
（可選）要顯示圖表影像、支援的儲存服務的憑證：
- Amazon S3 帳戶、儲存桶和存取金鑰
  - 文件
  - 存取金鑰需要s3:PutObjectAcl和s3:PutObject權限。
- Microsoft Azure 儲存帳戶和存取金鑰
  - 文件
- Google 雲端儲存帳戶和憑證
  - 文件

部署

在 Slack 中創建一個新機器人

前往 https://api.slack.com/apps?new_classic_app=1 並建立一個新的 Classic Slack 應用程式。 Lookerbot 使用即時訊息 API，因此它必須是經典 Slack 應用程式。我們將該應用程式稱為Looker，但這取決於您。
點擊“OAuth 和權限”選項卡，然後在“範圍”部分中使用“新增 OAuth 範圍”按鈕新增以下範圍 - 不要點擊綠色的“更新範圍”按鈕，因為這會將應用程式轉換為新範圍工作流程並會破壞您的應用程式！ :
1. channels:read
2. chat:write:bot
3. files:write:user
4. team:read
5. users:read
6. commands （如果您計劃配置斜杠命令）
導航至“應用程式主頁”並點擊“新增舊版機器人用戶”
在「OAuth 和權限」頁面頂部，按一下「將應用程式安裝到工作區」。
按一下「允許」以允許 Slack 工作區使用新建立的應用程式。
在「OAuth 和權限」頁面的頂部，複製「機器人使用者 OAuth 存取權杖」（稍後您將需要它）。注意：機器人令牌應以xoxb-開頭。
在「基本資訊」下，您可以為 Lookerbot 新增圖示和描述。這是我們使用的圖標。

預設情況下，Slack 應用程式是您團隊內部的。不要「分發」您的 Slack 應用程式 – 這將使世界上所有 Slack 用戶都可以使用它。

重要的

請注意：下面的一些環境變數已更改。您可能需要調整它們才能保持其正常工作。

Heroku 部署

部署機器人的最快方法是使用 Heroku 的一鍵部署按鈕，該按鈕將為您的機器人配置伺服器。這將提示您為應用程式指定一個唯一的名稱，新增 Slack API 金鑰並配置所有必要的變數（請參閱下方的「環境變數」）。

設定環境變數並部署伺服器後，機器人就可以開始使用了！您也可以選擇配置斜線命令。

故障排除
看到 Heroku 上的依賴問題了嗎？應用YARN_PRODUCTION=false作為 env。到部署。有關更多詳細信息，請參閱heroku 跳過剪枝。

手動部署

該機器人是一個簡單的 Node.js 應用程式。應用程式需要能夠存取 Looker 實例的 API 和 Slack 的 API。如果您有 Looker 的自架實例，請務必開啟連接埠 19999 （或您的core_port ）以便存取 Looker API。

環境變數

該機器人完全透過環境變數進行配置。您需要設定這些變數：

SLACK_API_KEY （必要） – 您將在此處放置「機器人使用者 OAuth 存取權杖」。您可以在「安裝應用程式」下進入 Slack 應用程式。
LOOKER_URL （必需）– Looker 實例的 Web URL。
LOOKER_API_BASE_URL （必要） – Looker 實例的 API 端點。在大多數情況下，這將是網址，後面跟著:19999/api/4.0 （如果不同，請將19999替換為您的core_port ）。
LOOKER_API_CLIENT_ID （必要） – 您希望機器人執行的使用者的 API 用戶端 ID。這需要為 Looker 中的現有使用者建立 API 使用者或 API 金鑰。
LOOKER_API_CLIENT_SECRET （必要） – 您希望機器人執行的使用者的 API 用戶端金鑰。這需要為 Looker 中的現有使用者建立 API 使用者或 API 金鑰。
LOOKER_CUSTOM_COMMAND_FOLDER_ID （可選） – 您希望機器人用來定義自訂命令的資料夾的 ID。在 Looker 說明中心了解如何使用自訂指令。
LOOKER_WEBHOOK_TOKEN （可選）– Looker 管理面板中找到的 Webhook 驗證令牌。只有當您使用機器人發送計劃的 Webhook 時才需要這樣做。
SLACK_SLASH_COMMAND_TOKEN （可選） – 如果您想使用斜線命令或與 Lookerbot 互動訊息，請從應用程式設定的「基本資訊」部分提供驗證令牌。這就是機器人驗證傳入斜杠命令完整性的方式。
PORT （可選） – 機器人 Web 伺服器將在其上運行以接受斜線命令的連接埠。預設為3333 。

如果您想將這些設定變數放在檔案系統上，也可以將它們放在專案根目錄下的.env檔案中。如果環境變數都存在，則環境變數將優先於.env設定。

調整行為

有幾個環境變數可用來調整行為：

LOOKER_SLACKBOT_LOADING_MESSAGES – 將其設為false以停用發佈載入訊息。
LOOKERBOT_DATA_ACTIONS_IN_MESSAGES – 將其設為false以禁止向 Slack 使用者提供資料操作按鈕。

（可選）可視化影像的儲存服務

亞馬遜S3

SLACKBOT_S3_BUCKET （選用） – 如果您想使用 Lookerbot 發布視覺化映像，請提供 Amazon S3 儲存桶名稱。
SLACKBOT_S3_BUCKET_REGION （選用） – 如果您想使用 Lookerbot 發布視覺化影像，請提供 Amazon S3 儲存桶區域。預設為us-east-1 。
AWS_ACCESS_KEY_ID （可選）– 如果您想使用 Lookerbot 發布視覺化映像，請提供可寫入所提供儲存桶的 Amazon S3 存取金鑰。
AWS_SECRET_ACCESS_KEY （選用） – 如果您想使用 Lookerbot 發布視覺化映像，請提供可寫入所提供儲存桶的 Amazon S3 秘密存取金鑰。

微軟Azure

AZURE_STORAGE_ACCOUNT （選用）- 如果您想要使用 Microsoft Azure 儲存體來儲存 Lookerbot 發佈的視覺化影像，請提供您的 Azure 儲存體帳戶的名稱。
SLACKBOT_AZURE_CONTAINER （選用）- 如果您想要使用 Microsoft Azure 儲存體來儲存 Lookerbot 發佈的視覺化映像，請提供您想要使用的 Azure 儲存體帳戶中的容器名稱。
AZURE_STORAGE_ACCESS_KEY （選用）- 如果使用 Microsoft Azure 儲存體來儲存 Lookerbot 發佈的視覺化映像，請提供可寫入所提供的 Azure 儲存體帳戶和容器的存取金鑰。

谷歌雲端儲存

GOOGLE_CLOUD_BUCKET （可選）- 如果您想使用 Google Cloud 儲存 Lookerbot 發布的視覺化映像，請提供您的儲存桶的名稱。

如果 Lookerbot 在 Google Compute Engine 上運行，並且設定了適當的 API 範圍，則不需要進一步的資訊。

否則，您可以直接提供憑證：

GOOGLE_CLOUD_PROJECT （可選）- 如果您想使用 Google Cloud 儲存 Lookerbot 發布的視覺化映像，請提供您的專案名稱。
GOOGLE_CLOUD_CREDENTIALS_JSON （可選）- 如果使用 Google Cloud 儲存 Lookerbot 發布的視覺化圖片，請提供您從 Google Cloud 網站取得的憑證 JSON 檔案的內容。

自簽名或無效證書

如果您的 Looker 實例使用自簽名證書，Lookerbot 將預設拒絕連接到它。

將NODE_TLS_REJECT_UNAUTHORIZED環境變數設定為0將指示 Lookerbot 接受具有無效憑證的連線。在設定此變數之前，請確保您已徹底評估此操作對您的基礎架構的安全影響。

這應該只會影響 Looker 的本地部署。如果 Looker 託管您的實例，請勿設定此環境變數。

將機器人連接到多個 Looker 實例

如果您希望機器人連接到 Looker 的多個實例，則可以使用LOOKERS環境變數設定機器人。該變數應該是 JSON 物件的 JSON 數組，每個物件代表一個 Looker 實例及其身份驗證資訊。

JSON 物件應具有以下鍵：

url應該是實例的 Web url
apiBaseUrl應該是 API 端點
clientID應該是您希望機器人運行的使用者的 API 用戶端 ID
clientSecret應該是該 API 金鑰的秘密
customCommandFolderId是一個可選參數，表示您希望機器人用來定義自訂指令的資料夾。
webhookToken是一個可選參數。這是在 Looker 管理面板中找到的 Webhook 驗證令牌。只有當您使用機器人發送計劃的 Webhook 時才需要這樣做。

以下是連接到兩個 Looker 實例的 JSON 範例：

[{ "url" : " https://me.looker.com " , "apiBaseUrl" : " https://me.looker.com:19999/api/4.0 " , "clientId" : " abcdefghjkl " , "clientSecret" : " abcdefghjkl " },{ "url" : " https://me-staging.looker.com " , "apiBaseUrl" : " https://me-staging.looker.com:19999/api/4.0 " , "clientId" : " abcdefghjkl " , "clientSecret" : " abcdefghjkl " }]

設定LOOKERS時，將忽略LOOKER_URL 、 LOOKER_API_BASE_URL 、 LOOKER_API_CLIENT_ID 、 LOOKER_API_CLIENT_SECRET 、 LOOKER_WEBHOOK_TOKEN和LOOKER_CUSTOM_COMMAND_FOLDER_ID變數。

運行伺服器

運行伺服器：

確保 Node.js 已安裝
yarn install安裝依賴項
yarn start啟動機器人伺服器。伺服器將一直運行，直到您鍵入Ctrl+C將其停止。

附帶的Procfile還允許您使用 foreman 或 node-foreman 運行應用程式。這些庫還提供了創建與upstart 、 supervisord和systemd一起使用的腳本的簡單方法。

配置斜杠命令

與機器人互動不需要斜線命令。您可以直接私聊機器人或提及機器人，例如：

@looker 幫助

並使用所有功能。

然而，Slash 命令使用起來更友善一些，並且允許 Slack 自動完成，因此您可能需要設定它們。

前往 https://api.slack.com/apps 並找到您的應用程式。
選擇“斜線命令”並點擊“建立新命令”。
建立用於 Looker 機器人的命令。我們使用/looker，但這取決於您。
將 URL 設定為託管機器人伺服器的位置（如果您使用 Heroku 設定伺服器，這將是您選擇的唯一應用程式名稱）。斜線指令端點的路徑是/slack/receive ，因此如果您的伺服器位於https://example.com ，則 URL 將為https://example.com/slack/receive 。
在設定下，再次選擇“安裝應用程式”，然後選擇“重新安裝應用程式”並進行身份驗證。
在「基本資訊」下，取得驗證令牌。您將使用它來設定SLACK_SLASH_COMMAND_TOKEN環境變數。

將資料調度到 Slack

您可以使用機器人將預定的 Looks 傳送到 Slack。

點擊查看上的“安排”
將“目標”設定為“Webhook”
將“格式”設定保留為預設值。格式選擇將被忽略。
輸入您設定的伺服器的 Webhook URL。

發佈到公共/slack/post/channel/my-channel-name
- （Lookerbot 需要被邀請加入此頻道才能在其中發布。）
發佈到私人/slack/post/group/my-channel-name
- （Lookerbot 需要被邀請加入該群組才能在其中發布。）
直接向用戶發送訊息/slack/post/dm/myusername

這些 URL 以您的伺服器的 URL 為前綴。（如果您使用 Heroku 部署，這將是您選擇的唯一應用程式名稱）。因此，如果您的伺服器位於https://example.com並且您想要發佈到名為data-science頻道，則 URL 將為https://example.com/slack/post/channel/data-science 。

您需要確保LOOKER_WEBHOOK_TOKEN環境變數已正確設定為在 Looker 管理面板中找到的相同驗證令牌。

數據操作

從 Slack 執行資料操作

預設情況下，簡單的資料操作將出現在 Slack 中以進行單值視覺化。目前不支援具有表單的資料操作。

透過在操作定義中使用 Liquid 範本來限制對某些使用者的訪問，可以針對每個操作停用此功能。或者，可以使用機器人配置變數LOOKERBOT_DATA_ACTIONS_IN_MESSAGES完全停用操作按鈕。

使用 Slack 中的資料操作需要一個快速的附加配置：

前往 https://api.slack.com/apps 並找到您的應用程式。
選擇“互動式訊息”並啟用該功能。
對於“請求 URL”，將 URL 設定為託管機器人伺服器的位置（如果您使用 Heroku 設定伺服器，這將是您選擇的唯一應用程式名稱）。互動式訊息請求的路徑是/slack/action ，因此如果您的伺服器位於https://example.com ，則請求 URL 將為https://example.com/slack/action 。
請按照此處所述配置 Slash 命令令牌。

透過資料操作發送 Slack 訊息

機器人伺服器還實現端點，讓您可以輕鬆地將資料操作傳送到 Slack。

以下是您可以在 LookML 中實現的一些資料操作的範例。（將https://example.com替換為您的機器人的主機名稱。）

要利用此功能，您需要確保將LOOKER_WEBHOOK_TOKEN環境變數正確地設定為在 Looker 管理面板中找到的相同驗證令牌，就像調度資料一樣。

 dimension : value {
  sql : CONCAT (${first_name}, ' ' , ${last_name}) ;;

  # Let user choose a Slack channel to send to
  action : {
    label : " Send to Slack Channel "
    url : " https://example.com/data_actions "
    form_url : " https://example.com/data_actions/form "
    param : {
      name : " message "
      value : " :signal_strength: I sent a value from Slack: {{rendered_value}} "
    }
  }

  # Send to a particular Slack channel with a preset message
  action : {
    label : " Ping Channel "
    url : " https://example.com/data_actions "
    param : {
      name : " message "
      value : " :signal_strength: I sent a value from Slack: {{rendered_value}} "
    }
    param : {
      name : " channel "
      value : " #alerts "
    }
  }

  # Ask the user for a message to send to a particular channel
  action : {
    label : " Ask a Question "
    url : " https://example.com/data_actions "
    form_param : {
      name : " message "
      default : " Something seems wrong... (add details) "
    }
    param : {
      name : " channel "
      value : " #alerts "
    }
  }

}