การอัปโหลดข้อมูลการเข้าชม API ไปยัง Apigee - รุ่นเบต้า

Edge for Private Cloud v4.18.01

ลูกค้า Edge for Private Cloud ทุกรายต้องส่งสถิติเกี่ยวกับการเข้าชมพร็อกซี API ให้ Apigee Apigee ขอแนะนำให้ลูกค้าอัปโหลดข้อมูลดังกล่าววันละครั้ง โดยอาจสร้างงาน Cron

คุณต้องส่งข้อมูลสำหรับการติดตั้งใช้งาน API เวอร์ชันที่ใช้งานจริง แต่ไม่ต้องส่งข้อมูลสำหรับ API ในการติดตั้งใช้งานเพื่อการพัฒนาหรือการทดสอบ ในการติดตั้ง Edge ส่วนใหญ่ คุณจะต้องกำหนดองค์กรหรือสภาพแวดล้อมที่เฉพาะเจาะจงสำหรับ API เวอร์ชันที่ใช้งานจริง ข้อมูลที่คุณส่งมีไว้สำหรับองค์กรและสภาพแวดล้อมเวอร์ชันที่ใช้งานจริงเหล่านั้นเท่านั้น

Apigee มีเครื่องมือบรรทัดคำสั่ง apigee-analytics-collector เวอร์ชันเบต้าเพื่อช่วยในการอัปโหลดข้อมูลนี้ ยูทิลิตีนี้จะส่งรายงานปริมาณการเรียก API กลับไปยัง Apigee Edge สำหรับการติดตั้ง Private Cloud ทุกรายการสามารถใช้ยูทิลิตีนี้เพื่อดึงข้อมูลและรายงานข้อมูลการเข้าชมไปยัง Apigee ได้

การเข้าถึงข้อมูลที่อัปโหลดโดย apigee-analytics-collector

หลังจากอัปโหลดข้อมูลด้วยยูทิลิตี apigee-analytics-collector แล้ว คุณจะดูข้อมูลดังกล่าวได้ใน Apigee 360

หากต้องการดูข้อมูล ให้เข้าสู่ระบบ Apigee 360 แล้วเลือกตัวเลือกการใช้งาน หน้าการใช้งานจะแสดงกราฟการใช้งานและตารางข้อมูลการใช้งานสำหรับองค์กร Edge แต่ละองค์กร

กำลังติดตั้ง apigee-analytics-collector

ยูทิลิตี apigee-analytics-collector เป็น RPM ที่คุณติดตั้งโดยใช้ยูทิลิตี apigee-service

ตำแหน่งที่ติดตั้ง

โหนดที่คุณติดตั้งยูทิลิตี apigee-analytics-collector จะเป็นโหนดใดก็ได้ที่เข้าถึง Edge Management API ใน Edge Management Server ได้ คุณสามารถติดตั้งได้โดยตรงบนเซิร์ฟเวอร์การจัดการ บนโหนดอื่นของการติดตั้ง Edge หรือบนโหนดแยกต่างหาก ตราบใดที่โหนดนั้นสามารถส่งคำขอ API ไปยังเซิร์ฟเวอร์การจัดการได้

ข้อกำหนดในการเข้าถึงอินเทอร์เน็ต

ติดตั้งยูทิลิตี apigee-analytics-collector ในเครื่องที่มีการเข้าถึงอินเทอร์เน็ตภายนอก จากนั้นยูทิลิตี apigee-analytics-collector จะอัปโหลดข้อมูลไปยัง Apigee ได้โดยตรง

หากไม่มีโหนดที่มีทั้งสิทธิ์เข้าถึง Edge Management API ใน Edge Management Server และสิทธิ์เข้าถึงอินเทอร์เน็ตภายนอก คุณสามารถใช้ Edge Management API เพื่อบันทึกข้อมูลการเข้าชมไว้ในเครื่องได้ จากนั้นคุณต้องโอนข้อมูลไปยังเครื่องที่มีการเข้าถึงอินเทอร์เน็ตเพื่ออัปโหลดไปยัง Apigee ในสถานการณ์นี้ คุณไม่จำเป็นต้องใช้ยูทิลิตี apigee-analytics-collector ดูข้อมูลเพิ่มเติมได้ที่การอัปโหลดข้อมูลไปยัง Apigee ด้วยตนเองด้านล่าง

การติดตั้ง

ใช้คำสั่งต่อไปนี้เพื่อติดตั้งยูทิลิตี apigee-analytics-collector เนื่องจากคุณกำลังติดตั้งไฟล์ RPM คำสั่งนี้จึงต้องเรียกใช้โดยผู้ใช้รากหรือผู้ใช้ที่มีสิทธิ์เข้าถึง sudo เต็มรูปแบบ สิทธิ์เข้าถึง sudo แบบเต็มหมายความว่าผู้ใช้มีสิทธิ์เข้าถึง sudo เพื่อดำเนินการแบบเดียวกับรูท

> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector install 

กำลังเรียกใช้ apigee-analytics-collector

ส่วนนี้จะอธิบายวิธีเรียกใช้ยูทิลิตี apigee-analytics-collector

การกำหนดค่าผู้ใช้ให้เรียกใช้ apigee-analytics-collector

คุณต้องเรียกใช้ apigee-analytics-collector ในฐานะผู้ใช้ที่ไม่ใช่รูท ผู้ใช้รายนี้ต้องมีสิทธิ์เข้าถึง sudo แบบเต็มสำหรับผู้ใช้ "apigee"

หากต้องการกำหนดค่าผู้ใช้ให้มีสิทธิ์เข้าถึง sudo แบบเต็มสำหรับผู้ใช้ "apigee" ให้ใช้คำสั่ง "visudo" เพื่อแก้ไขไฟล์ sudoers เพื่อเพิ่มข้อมูลต่อไปนี้

analyticsUser        ALL=(apigee)      NOPASSWD: ALL

โดย analyticsUser คือชื่อผู้ใช้ของบุคคลที่เรียกใช้ยูทิลิตี apigee-analytics-collector

หลังจากติดตั้งยูทิลิตี apigee-analytics-collector และกำหนดค่าผู้ใช้แล้ว คุณสามารถทดสอบยูทิลิตีได้โดยเรียกใช้คำสั่งความช่วยเหลือสำหรับยูทิลิตี apigee-analytics-collector ดังนี้

> /opt/apigee/apigee-service/bin/ apigee-service apigee-analytics-collector export traffic --help

ข้อมูลที่จำเป็นในการเรียกใช้ apigee-analytics-collector

คุณต้องมีข้อมูลต่อไปนี้เพื่อเรียกใช้คำสั่ง apigee-analytics-collector และส่งต่อข้อมูลไปยัง Apigee

• apigee_mgmt_api_uri: URL ฐานของ Edge API ในเซิร์ฟเวอร์การจัดการ โดยปกติแล้ว URL นี้จะอยู่ในรูปแบบต่อไปนี้
  http://ms_IP:8080/v1
  
  โดยที่ ms_IP คือที่อยู่ IP หรือเซิร์ฟเวอร์การจัดการ และ 8080 คือพอร์ตที่ Edge API ใช้ หากคุณสร้างรายการ DNS สำหรับ Edge API แล้ว URL จะอยู่ในรูปแบบต่อไปนี้
  http://ms_DNS/v1
  
  หากคุณเปิดใช้ TLS ใน Edge Management API แล้ว URL จะอยู่ในรูปแบบต่อไปนี้
  https://ms_IP:8080/v1
  https://ms_DNS/v1
• apigee_mgmt_api_email: อีเมลของบัญชีที่มีสิทธิ์เข้าถึง Edge /stats API ซึ่งมักจะเป็นอีเมลของผู้ดูแลระบบ Edge หรืออีเมลของผู้ดูแลระบบองค์กรสำหรับองค์กรเวอร์ชันที่ใช้งานจริง
• apigee_mgmt_api_password: รหัสผ่าน Edge สำหรับบัญชีที่ระบุโดย apigee_mgmt_api_email
• apigee_analytics_client_id และ apigee_analytics_secret: ข้อมูลเข้าสู่ระบบสำหรับการอัปโหลดข้อมูลไปยัง Apigee โปรดส่งคำขอแจ้งปัญหาไปยังทีมสนับสนุนของ Apigee เพื่อรับ apigee_analytics_client_id และ apigee_analytics_secret

คำสั่งตัวอย่าง

ด้านล่างนี้คือตัวอย่างคำสั่งเพื่อดึงข้อมูลการเข้าชมสำหรับองค์กรและสภาพแวดล้อมทั้งหมดในการติดตั้ง Edge และอัปโหลดข้อมูลดังกล่าวไปยัง Apigee โปรดสังเกตวิธีใช้ apigee-service เพื่อเรียกใช้คำสั่ง apigee-analytics-collector ดังนี้

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

โปรดทราบว่าคำสั่งมีข้อมูลที่จำเป็นทั้งหมด เช่น apigee_analytics_client_id และ apigee_analytics_secret

คุณควรเห็นผลลัพธ์ในรูปแบบต่อไปนี้

[
  {
    "org": "myOrg",
    "env": "prod",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  },
  {
    "org": "VALIDATE",
    "env": "test",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  }
]

ใช้ตัวเลือกบรรทัดคำสั่งกับคำสั่งเพื่อควบคุมการทำงาน ใช้ตัวเลือกต่อไปนี้เพื่อระบุองค์กรและสภาพแวดล้อมที่จะรวมไว้ในข้อมูลที่สร้างขึ้น

• -i, --include_orgs <comma-separated list of items>
• -x, --exclude_orgs <รายการที่คั่นด้วยคอมมา>
• -n, --include_envs <comma-separated list of items>
• -e, --exclude_envs <comma-separated list of items>

เช่น หากต้องการระบุเฉพาะองค์กรและสภาพแวดล้อมเวอร์ชันที่ใช้งานจริง ให้ใช้ตัวเลือก -i (หรือ --include_orgs) และ -n (หรือ --include_envs) ดังนี้

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

ในตัวอย่างนี้ คุณจะรวบรวมข้อมูลจากสภาพแวดล้อมเวอร์ชันที่ใช้งานจริงของ myOrg เท่านั้น

หากต้องการดัมพ์ข้อมูลไปยังหน้าจอเพื่อตรวจสอบก่อนส่งไปยัง Apigee ให้ใช้ตัวเลือก -S ดังนี้

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

ตัวเลือก -S จะละเว้นการอัปโหลดข้อมูลไปยัง Apigee จากนั้นคุณจะเรียกใช้คำสั่งอีกครั้งได้โดยไม่ต้องใช้ตัวเลือก -S เพื่อส่งข้อมูลไปยัง Apigee

เหตุผลหนึ่งในการใช้ตัวเลือก -S คือเพื่อให้คุณแสดงข้อมูลประเภทต่างๆ ในเครื่องได้ Apigee กำหนดให้คุณอัปโหลดข้อมูลการเข้าชม API เท่านั้น แต่ตัวเลือก -D จะช่วยให้คุณแสดงข้อมูลเกี่ยวกับผลิตภัณฑ์ API, นักพัฒนาแอป, แอป หรือพร็อกซี API ได้ ตัวอย่างด้านล่างใช้ตัวเลือก -D และ -S เพื่อแสดงข้อมูลนักพัฒนาแอปในเครื่อง

>  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S -D devs \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

ใส่ตัวเลือก -v เพื่อรับเอาต์พุตแบบละเอียด และตัวเลือก -R เพื่อดูคำสั่ง curl ที่สร้างโดย apigee-analytics-collector

 >  /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector export traffic -i myOrg -n prod -S -R -v \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

ส่วนถัดไปจะมีรายการตัวเลือกบรรทัดคำสั่งทั้งหมด

พารามิเตอร์คำสั่ง

ตารางต่อไปนี้แสดงชุดตัวเลือกทั้งหมดสำหรับยูทิลิตี apigee-analytics-collector

การอัปโหลดข้อมูลไปยัง Apigee ด้วยตนเอง

Apigee ขอแนะนำให้คุณติดตั้งยูทิลิตี apigee-analytics-collector ในเครื่องที่มีการเข้าถึงอินเทอร์เน็ตภายนอก จากนั้นยูทิลิตี apigee-analytics-collector จะอัปโหลดข้อมูลไปยัง Apigee ได้โดยตรง

อย่างไรก็ตาม หากเครื่องไม่มีการเข้าถึงอินเทอร์เน็ตภายนอก ให้ใช้ Edge Management API เพื่อรวบรวมข้อมูลการเข้าชม จากนั้นใช้คำสั่ง cURL เพื่ออัปโหลดไปยัง Apigee จากเครื่องที่มีการเข้าถึงอินเทอร์เน็ต คุณต้องทำขั้นตอนนี้ซ้ำสำหรับองค์กรและสภาพแวดล้อมเวอร์ชันที่ใช้งานจริงทุกรายการในการติดตั้ง Edge

ใช้คำสั่ง cURL ต่อไปนี้เพื่อรวบรวมข้อมูลการเข้าชมสำหรับองค์กรและสภาพแวดล้อมที่เฉพาะเจาะจงในช่วงเวลาที่ระบุ

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://<ms_IP>:8080/v1/organizations/{org_name}/environments/{env_name}/stats/apiproxy?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour"

คำสั่งนี้ใช้ API จำนวนข้อความ Get API ของ Edge ในคำสั่งนี้

• apigee_mgmt_api_email:apigee_mgmt_api_password ระบุอีเมลของบัญชีที่มีสิทธิ์เข้าถึง Edge /stats API
• <ms_IP> คือที่อยู่ IP หรือชื่อ DNS ของเซิร์ฟเวอร์การจัดการ Edge
• {org_name} และ {env_name} ระบุองค์กรและสภาพแวดล้อม
• apiproxy คือมิติข้อมูลที่จัดกลุ่มเมตริกตามพร็อกซี API
• MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour ระบุช่วงเวลาที่แบ่งออกเป็นหน่วยเวลาของเมตริกที่จะรวบรวม โปรดทราบว่าคำสั่ง cURL ใช้รหัสฐานสิบหก %20 สำหรับช่องว่างในช่วงเวลา

ตัวอย่างเช่น หากต้องการรวบรวมจำนวนข้อความพร็อกซี API เป็นรายชั่วโมงในช่วงระยะเวลา 24 ชั่วโมง ให้ใช้ การเรียก Management API ต่อไปนี้ timeRange มีอักขระที่เข้ารหัส URL

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://192.168.56.103:8080/v1/organizations/myOrg/environments/prod/stats/apiproxy?select=sum(message_count)&timeRange=01%2F01%2F2018%2000%3A00~01%2F02%2F2018%2000%3A00"

คุณควรเห็นการตอบกลับในรูปแบบต่อไปนี้

{
  "environments" : [ {
    "metrics" : [ {
      "name" : "sum(message_count)",
      "values": [
                {
                  "timestamp": 1514847600000,
                  "value": "35.0"
                },
                {
                  "timestamp": 1514844000000,
                  "value": "19.0"
                },
                {
                  "timestamp": 1514840400000,
                  "value": "58.0"
                },
                {
                  "timestamp": 1514836800000,
                  "value": "28.0"
                },
                {
                  "timestamp": 1514833200000,
                  "value": "29.0"
                },
                {
                  "timestamp": 1514829600000,
                  "value": "33.0"
                },
                {
                  "timestamp": 1514826000000,
                  "value": "26.0"
                },
                {
                  "timestamp": 1514822400000,
                  "value": "57.0"
                },
                {
                  "timestamp": 1514818800000,
                  "value": "41.0"
                },
                {
                  "timestamp": 1514815200000,
                  "value": "27.0"
                },
                {
                  "timestamp": 1514811600000,
                  "value": "47.0"
                },
                {
                  "timestamp": 1514808000000,
                  "value": "66.0"
                },
                {
                  "timestamp": 1514804400000,
                  "value": "50.0"
                },
                {
                  "timestamp": 1514800800000,
                  "value": "41.0"
                },
                {
                  "timestamp": 1514797200000,
                  "value": "49.0"
                },
                {
                  "timestamp": 1514793600000,
                  "value": "35.0"
                },
                {
                  "timestamp": 1514790000000,
                  "value": "89.0"
                },
                {
                  "timestamp": 1514786400000,
                  "value": "42.0"
                },
                {
                  "timestamp": 1514782800000,
                  "value": "47.0"
                },
                {
                  "timestamp": 1514779200000,
                  "value": "21.0"
                },
                {
                  "timestamp": 1514775600000,
                  "value": "27.0"
                },
                {
                  "timestamp": 1514772000000,
                  "value": "20.0"
                },
                {
                  "timestamp": 1514768400000,
                  "value": "12.0"
                },
                {
                  "timestamp": 1514764800000,
                  "value": "7.0"
                }
              ]
            }
          ],
          "name" : "proxy1"
  } ],
  "metaData" : {
    "errors" : [ ],
    "notices" : [ "query served by:53dab80c-e811-4ba6-a3e7-b96f53433baa", "source pg:6b7bab33-e732-405c-a5dd-4782647ce096", "Table used: myorg.prod.agg_api" ]
  }
}

จากนั้นหากต้องการอัปโหลดข้อมูลดังกล่าวไปยัง Apigee จากเครื่องที่มีการเข้าถึงอินเทอร์เน็ต ให้ใช้คำสั่ง cURL ต่อไปนี้

curl -X POST -H 'Content-Type:application/json' \
-u apigee_analytics_client_id:apigee_analytics_secret \
https://nucleus-api-prod.apigee.com/v1/apigee-analytics-cli-api/traffic/orgs/{org_name}/apis -d '{"environments"...}'

โดยที่

• apigee_analytics_client_id:apigee_analytics_secret ระบุข้อมูลเข้าสู่ระบบสำหรับการอัปโหลดข้อมูลไปยัง Apigee ที่คุณได้รับจากทีมสนับสนุนของ Apigee
• {org_name} ระบุองค์กร
• {"environments"...} มีผลลัพธ์ของคำสั่ง cURL ที่คุณใช้เพื่อรวบรวมสถิติด้านบน