Juniper NETWORKS Streaming API -ohjelmisto

Tuotetiedot

Tekniset tiedot

• Tuotteen nimi: Paragon Active Assurance
• Versio: 4.1
• Julkaistu: 2023

Esittely:
Tämä opas sisältää ohjeet tietojen poimimiseen Paragon Active Assurancesta tuotteen suoratoistosovellusliittymän avulla. Suoratoistoasiakas ja API sisältyvät Paragon Active Assurance -asennukseen, mutta joitain määrityksiä tarvitaan ennen API:n käyttöä. Määritysprosessi on käsitelty "Streaming API:n määrittäminen" -osiossa.

Streaming API:n määrittäminen:
Seuraavissa vaiheissa kuvataan suoratoisto-API:n määritysprosessi:

Yliview
Kafka on tapahtumien suoratoistoalusta, joka on suunniteltu reaaliaikaiseen tiedon keräämiseen ja tallentamiseen eri lähteistä. Se mahdollistaa tapahtumavirtojen hallinnan hajautetusti, skaalautuvasti, vikasietoisesti ja turvallisesti. Tämä opas keskittyy Kafkan määrittämiseen käyttämään Paragon Active Assurance Control Centerin Streaming API -ominaisuutta.

Terminologia
Streaming API:n avulla ulkoiset asiakkaat voivat hakea mittaustietoja Kafkasta. Testaajien testin tai valvontatehtävän aikana keräämät mittarit lähetetään Stream-palveluun. Käsittelyn jälkeen Stream-palvelu julkaisee nämä tiedot Kafkassa muiden metatietojen kanssa.

Streaming API:n käyttöönotto
Ota Streaming API käyttöön seuraavasti:

1. Suorita seuraavat komennot Control Center -palvelimella sudon avulla:

KAFKA_METRICS_ENABLED = Todelliset sudo ncc -palvelut mahdollistavat aikaskaalatut b-mittarit sudo ncc -palvelut alkavat aikaskaalatut b-mittarit sudo ncc -palvelut käynnistyvät uudelleen

Sen varmistaminen, että Streaming API toimii ohjauskeskuksessa:
Voit varmistaa, että saat tietoja oikeista Kafka-aiheista:

1. Asenna kafkacat-apuohjelma seuraavilla komennoilla:
   sudo apt-get päivitys
   sudo apt-get install kafkacat

2. Korvaa "oma tili" tilisi lyhyellä nimellä
   Ohjauskeskus URL:
   vie METRICS_TOPIC=paa.public.accounts.myaccount.metrics
   vie METADATA_TOPIC=paa.public.accounts.myaccount.metadata

3. Suorita seuraava komento kohteeseen view mittarit:
   kafkacat -b ${KAFKA_FQDN}:9092 -t ${METRICS_TOPIC} -C -e
   Huom: Yllä oleva komento näyttää mittarit.
4. Vastaanottaja view metatiedot, suorita seuraava komento:
   kafkacat -b ${KAFKA_FQDN}:9092 -t ${METADATA_TOPIC} -C -e

Huom: Yllä oleva komento näyttää metatiedot, mutta se ei päivity yhtä usein.

Asiakas Examples
Asiakkaalle esimampLisätietoja ja lisätietoja, katso käyttöoppaan sivu 14.

FAQ (usein kysytyt kysymykset)

• K: Mikä Paragon Active Assurance on?
  V: Paragon Active Assurance on tuote, joka tarjoaa seuranta- ja testausominaisuudet.
• K: Mikä on Streaming API?
  V: Streaming API on Paragon Active Assurancen ominaisuus, jonka avulla ulkoiset asiakkaat voivat hakea mittaustietoja Kafkasta.
• K: Kuinka voin ottaa Streaming API:n käyttöön?
  V: Ota Streaming API käyttöön noudattamalla ohjeita, jotka on esitetty käyttöoppaan kohdassa "Streaming API:n käyttöönotto".
• K: Kuinka voin varmistaa, että Streaming API toimii?
  V: Katso "Streaming API:n toiminnan tarkistaminen ohjauskeskuksessa" -osiosta ohjeet Streaming API:n toimivuuden tarkistamiseen.

Johdanto

Tässä oppaassa kuvataan, kuinka tietoja voidaan poimia Paragon Active Assurancesta tuotteen suoratoistosovellusliittymän kautta.
API ja suoratoistoasiakas sisältyvät Paragon Active Assurance -asennukseen. Tarvitset kuitenkin hieman konfigurointia, ennen kuin voit käyttää API:ta. Tämä käsitellään luvussa "Streaming API:n määrittäminen" sivulla 1.

Yliview
Tässä luvussa kerrotaan, kuinka Streaming API määritetään sallimaan mittausviestien tilaaminen Kafkan kautta.
pr
Alla käydään läpi:

• Streaming API:n käyttöönotto
• Kuinka määrittää Kafka kuuntelemaan ulkoisia asiakkaita
• Kuinka määrittää Kafka käyttämään ACL-luetteloita ja määrittämään SSL-salauksen mainituille asiakkaille

Mikä on Kafka?
Kafka on tapahtumien suoratoistoalusta, joka mahdollistaa eri tapahtumalähteistä (antureista, tietokannoista, mobiililaitteista) lähetetyn datan reaaliaikaisen tallennuksen tapahtumavirtojen muodossa sekä näiden tapahtumavirtojen kestävän tallennuksen myöhempää hakua ja käsittelyä varten.
Kafkan avulla on mahdollista hallita tapahtumien suoratoistoa päästä päähän hajautetusti, erittäin skaalautuvasti, joustavasti, vikasietoisesti ja turvallisesti.

HUOMAA: Kafka voidaan konfiguroida monilla eri tavoilla, ja se on suunniteltu skaalautuvuutta ja redundantteja järjestelmiä varten. Tämä asiakirja keskittyy vain siihen, kuinka se määritetään käyttämään Paragon Active Assurance Control Centerissä olevaa Streaming API -ominaisuutta. Tarkempia asetuksia varten katso virallinen Kafka-dokumentaatio: kafka.apache.org/26/documentation.html.

Terminologia

• Kafka: Tapahtuman suoratoistoalusta.
• Kafka-aihe: Tapahtumakokoelma.
• Kafka-tilaaja/kuluttaja: Komponentti, joka vastaa Kafka-aiheeseen tallennettujen tapahtumien hakemisesta.
• Kafka-välittäjä: Kafka-klusterin tallennuskerroksen palvelin.
• SSL/TLS: SSL on suojattu protokolla, joka on kehitetty tietojen lähettämiseen turvallisesti Internetin kautta. TLS on SSL:n seuraaja, joka otettiin käyttöön vuonna 1999.
• SASL: Kehys, joka tarjoaa mekanismeja käyttäjien todentamiseen, tietojen eheyden tarkistamiseen ja salaukseen.
• Streaming API -tilaaja: Komponentti, joka vastaa Paragon Active Assurancessa määritettyihin aiheisiin tallennettujen tapahtumien noutamisesta ja joka on tarkoitettu ulkoiseen käyttöön.
• Varmenteen myöntäjä: Luotettu entiteetti, joka myöntää ja kumoaa julkisen avaimen varmenteita.
• Varmenteen myöntäjän juurivarmenne: Julkisen avaimen varmenne, joka tunnistaa varmentajan.

Miten Streaming API toimii
Kuten aiemmin mainittiin, Streaming API:n avulla ulkoiset asiakkaat voivat hakea tietoja mittareista Kafkasta.

Kaikki testiagenttien testin tai valvontatehtävän aikana keräämät mittarit lähetetään Stream-palveluun. Käsittelyvaiheen jälkeen Stream-palvelu julkaisee nämä mittarit Kafkassa yhdessä muiden metatietojen kanssa.

Kafka Aiheet
Kafkalla on käsite aiheista, joihin kaikki tiedot julkaistaan. Paragon Active Assurancessa on monia tällaisia ​​Kafka-aiheita saatavilla; kuitenkin vain osa niistä on tarkoitettu ulkoiseen käyttöön.
Jokaisella Paragon Active Assurance -tilillä Control Centerissä on kaksi erityistä aihetta. Alla ACCOUNT on tilin lyhyt nimi:

• paa.public.accounts.{ACCOUNT}.metrics
  • Kaikki tietyn tilin mittausviestit julkaistaan ​​tähän aiheeseen
  • Suuret tietomäärät
  • Suuri päivitystaajuus
• paa.public.accounts.{ACCOUNT}.metadata
  • Sisältää mittaritietoihin liittyviä metatietoja, esimampmittauksiin liittyvä testi, monitori tai testiagentti
  • Pienet tietomäärät
  • Matala päivitystiheys

Streaming API:n käyttöönotto

HUOM: Nämä ohjeet on suoritettava Control Center -palvelimessa sudo-toiminnolla.

Koska Streaming API lisää ohjauskeskukseen jonkin verran lisäkustannuksia, se ei ole oletuksena käytössä. Jotta API voidaan ottaa käyttöön, meidän on ensin otettava käyttöön mittareiden julkaiseminen Kafkalle pääkokoonpanossa file:

• /etc/netrounds/netrounds.conf

KAFKA_METRICS_ENABLED = Tosi

VAROITUS: Tämän ominaisuuden käyttöönotto saattaa vaikuttaa Control Centerin suorituskykyyn. Varmista, että olet mitoittanut esiintymäsi vastaavasti.

Seuraavaksi näiden mittareiden välittäminen oikeisiin Kafka-aiheisiin:

• /etc/netrounds/metrics.yaml

streaming-api: totta

Ota Streaming API -palvelut käyttöön ja käynnistä ne suorittamalla:

• sudo ncc -palvelut mahdollistavat timescaledb-mittaukset
• sudo ncc -palvelut aloittavat timescaledb-metriikan

Lopuksi käynnistä palvelut uudelleen:

• sudo ncc -palvelut käynnistyvät uudelleen

Ohjauskeskuksessa tarkistetaan, että Streaming API toimii

HUOMAA: Nämä ohjeet on suoritettava Control Center -palvelimessa.

Voit nyt varmistaa, että saat mittareita oikeista Kafka-aiheista. Voit tehdä tämän asentamalla kafkacat-apuohjelman:

• sudo apt-get päivitys
• sudo apt-get install kafkacat

Jos sinulla on testi tai monitori käynnissä Control Centerissä, sinun pitäisi pystyä vastaanottamaan näitä aiheita koskevia mittareita ja metatietoja kafkacatilla.
Korvaa myaccount tilisi lyhyellä nimellä (tämän näet ohjauskeskuksessasi URL):

• vie METRICS_TOPIC=paa.public.accounts.myaccount.metrics
• vie METADATA_TOPIC=paa.public.accounts.myaccount.metadata

Sinun pitäisi nyt nähdä mittareita suorittamalla tämä komento:

• kafkacat -b ${KAFKA_FQDN}:9092 -t ${METRICS_TOPIC} -C -e

Vastaanottaja view metatiedot, suorita seuraava komento (huomaa, että tämä ei päivity yhtä usein):

• kafkacat -b ${KAFKA_FQDN}:9092 -t ${METADATA_TOPIC} -C -e

HUOMAA:
kafkacat” Asiakas examples ”sivulla 14

Tämä varmistaa, että meillä on toimiva Streaming API ohjauskeskuksesta. Todennäköisimmin olet kuitenkin kiinnostunut käyttämään tietoja ulkoisesta asiakkaasta. Seuraavassa osiossa kuvataan, kuinka Kafka avataan ulkoista käyttöä varten.

Kafkan avaaminen ulkoisille isännille

HUOMAA: Nämä ohjeet on suoritettava Control Center -palvelimessa.

Oletuksena Ohjauskeskuksessa toimiva Kafka on määritetty kuuntelemaan vain localhostilla sisäiseen käyttöön. Kafka on mahdollista avata ulkoisille asiakkaille muuttamalla Kafka-asetuksia.

Yhdistäminen Kafkaan: Varoitukset

VAROITUS: Lue tämä huolellisesti, sillä Kafkan kanssa on helppo törmätä yhteysongelmiin, jos et ole ymmärtänyt näitä käsitteitä.

Tässä asiakirjassa kuvatuissa ohjauskeskuksen asetuksissa on vain yksi Kafka-välittäjä.
Huomaa kuitenkin, että Kafka-välittäjän on tarkoitus toimia osana Kafka-klusteria, joka voi koostua useista Kafka-välittäjistä.
Kun muodostat yhteyden Kafka-välittäjään, Kafka-asiakas määrittää ensimmäisen yhteyden. Tässä yhteydessä Kafka-välittäjä puolestaan ​​palauttaa luettelon "ilmoitetuista kuuntelijoista", joka on luettelo yhdestä tai useammasta Kafka-välittäjästä.
Saatuaan tämän luettelon Kafka-asiakas katkaisee yhteyden ja muodostaa sitten uudelleen yhteyden johonkin näistä mainostetuista kuuntelijoista. Mainostettujen kuuntelijoiden on sisällettävä isäntänimiä tai IP-osoitteita, jotka ovat Kafka-asiakassovelluksen käytettävissä, tai asiakas ei muodosta yhteyttä.
Jos käytetään SSL-salausta, johon liittyy tiettyyn isäntänimeen sidottu SSL-sertifikaatti, on vielä tärkeämpää, että Kafka-asiakas saa oikean osoitteen yhteyden muodostamista varten, koska muuten yhteys voidaan hylätä.
Lue lisää Kafka-kuuntelijoista täältä: www.confluent.io/blog/kafka-listeners-explained

SSL/TLS-salaus
Varmistaaksemme, että vain luotetut asiakkaat voivat käyttää Kafkaa ja Streaming API:ta, meidän on määritettävä seuraavat:

• Todennus: Asiakkaiden on annettava käyttäjätunnus ja salasana suojatun SSL/TLS-yhteyden kautta asiakkaan ja Kafkan välillä.
• Valtuutus: Todennetut asiakkaat voivat suorittaa ACL-luetteloiden säätelemiä tehtäviä.

Tässä on loppuview:

*) Käyttäjätunnus/salasana todennus suoritettu SSL-salatulla kanavalla

Ymmärtääksesi täysin, kuinka SSL/TLS-salaus toimii Kafkassa, tutustu viralliseen dokumentaatioon: docs.confluent.io/platform/current/kafka/encryption.html

SSL/TLS-sertifikaatti ohiview

HUOMAA: Tässä alaosiossa käytämme seuraavaa terminologiaa:

Todistus: Varmenteen myöntäjän (CA) allekirjoittama SSL-varmenne. Jokaisella Kafka-välittäjällä on yksi.
Keystore: Avainsäilö file joka tallentaa varmenteen. Avainsäilö file sisältää varmenteen yksityisen avaimen; siksi se on säilytettävä turvallisesti.
Truststore: A file sisältää luotetut CA-varmenteet.

Ulkoisen asiakkaan ja Ohjauskeskuksessa toimivan Kafkan välisen todennuksen määrittämiseksi molemmilla puolilla on oltava avainsäilö, joka on määritetty varmenteen myöntäjän (CA) allekirjoittaman asiaankuuluvan varmenteen kanssa yhdessä CA-juurivarmenteen kanssa.
Tämän lisäksi asiakkaalla tulee olla myös luottamuskauppa CA-juurivarmenteella.
CA-juurivarmenne on yhteinen Kafka-välittäjälle ja Kafka-asiakkaalle.

Vaadittujen sertifikaattien luominen
Tämä on käsitelty "Liite" sivulla 17.

Kafka Broker SSL/TLS -määritykset ohjauskeskuksessa

HUOMAA: Nämä ohjeet on suoritettava Control Center -palvelimessa.

HUOMAA: Ennen kuin jatkat, sinun on luotava SSL-varmenteen sisältävä avainsäilö noudattamalla "Liite" sivulla 17 olevia ohjeita. Alla mainitut polut tulevat näistä ohjeista.
SSL-avainsäilö on a file tallennettu levylle file laajennus .jks.

Kun olet luonut tarvittavat varmenteet sekä Kafka-välittäjälle että Kafka-asiakkaalle, voit jatkaa määrittämällä Kafka-välittäjän, joka on käynnissä Ohjauskeskuksessa. Sinun on tiedettävä seuraavat asiat:

• : Ohjauskeskuksen julkinen isäntänimi; tämän on oltava Kafka-asiakkaiden käytettävissä ja ratkaistavissa.
• : SSL-varmennetta luotaessa annettu avainsäilön salasana.
• ja : Nämä ovat salasanat, jotka haluat asettaa järjestelmänvalvojalle ja asiakaskäyttäjälle. Huomaa, että voit lisätä käyttäjiä, kuten esimample.

Muokkaa tai liitä (sudo-käytöllä) alla olevia ominaisuuksia /etc/kafka/server.properties lisäämällä yllä olevat muuttujat kuvan mukaisesti:

VAROITUS: Älä poista PLAINTEXT://localhost:9092; tämä rikkoo Control Center -toiminnon, koska sisäiset palvelut eivät pysty kommunikoimaan.

• …
• # Osoitteet, joita Kafka-välittäjä kuuntelee.
• listeners=PLAINTEXT://localhost:9092,SASL_SSL://0.0.0.0:9093
• # Nämä ovat isäntiä, jotka mainostetaan takaisin kaikille muodostaville asiakkaille.
• advertisingd.listeners=PLAINTEXT://localhost:9092,SASL_SSL:// :9093…
• ####### MUKAUTETTU ASETUS
• # SSL-ASETUKSET
• ssl.endpoint.identification.algorithm=
  ssl.keystore.location=/var/ssl/private/kafka.server.keystore.jks
• ssl.keystore.password=
• ssl.key.password=
• ssl.client.auth=ei mitään
• ssl.protocol=TLSv1.2
• # SASL-kokoonpano
• sasl.enabled.mechanisms=PLAIN
• käyttäjätunnus=”admin” \
• salasana =" ”\
• user_admin=” ”\
• user_client=” ”;
• # HUOMAA lisää käyttäjiä voidaan lisätä käyttäjällä_ =
• # Valtuutus, ota ACL:t käyttöön
• authorizer.class.name=kafka.security.authorizer.AclAuthorizer super.users=Käyttäjä:admin

Käyttöoikeusluetteloiden (ACL) määrittäminen

ACL:ien käyttöönotto localhostissa

VAROITUS: Meidän on ensin määritettävä ACL:t localhostille, jotta ohjauskeskus itse voi silti käyttää Kafkaa. Jos tätä ei tehdä, asiat hajoavat.

• –authorizer kafka.security.authorizer.AclAuthorizer \
• –authorizer-properties zookeeper.connect=localhost:2181 \
• –lisää –allow-principal User:ANONYMOUS –allow-host 127.0.0.1 –klusteri
• /usr/lib/kafka/bin/kafka-acls.sh \
• –authorizer kafka.security.authorizer.AclAuthorizer \
• –authorizer-properties zookeeper.connect=localhost:2181 \
• –add –allow-principal User:ANONYMOUS –allow-host 127.0.0.1 –aihe '*'
• /usr/lib/kafka/bin/kafka-acls.sh \
• –authorizer kafka.security.authorizer.AclAuthorizer \
• –authorizer-properties zookeeper.connect=localhost:2181 \
• –lisää –allow-principal User:ANONYMOUS –allow-host 127.0.0.1 –group '*'

Tämän jälkeen meidän on otettava käyttöön ACL-luettelot ulkoiselle vain luku -käytölle, jotta ulkoiset käyttäjät voivat lukea paa.public.*-aiheita.

### ACL-merkinnät anonyymeille käyttäjille /usr/lib/kafka/bin/kafka-acls.sh \

HUOM: Tarkempia säätöjä varten katso virallinen Kafka-dokumentaatio.

• –authorizer kafka.security.authorizer.AclAuthorizer \
• –authorizer-properties zookeeper.connect=localhost:2181 \
• –lisää –allow-principal User:* –operaatio lue –toimintokuvaa \ –ryhmä 'NCC'
• /usr/lib/kafka/bin/kafka-acls.sh \
• –authorizer kafka.security.authorizer.AclAuthorizer \
• –authorizer-properties zookeeper.connect=localhost:2181 \
• –lisää –allow-principal User:* –operation read –operation description \ –aihe paa.public. –resurssimallityypin etuliite

Kun olet tehnyt tämän, sinun on käynnistettävä palvelut uudelleen:

### ACL-merkinnät ulkoisille käyttäjille /usr/lib/kafka/bin/kafka-acls.sh \

• sudo ncc -palvelut käynnistyvät uudelleen

Varmistaaksesi, että asiakas voi muodostaa suojatun yhteyden, suorita seuraava komento ulkoisessa laitteessa
asiakastietokone (ei Ohjauskeskus-palvelimessa). Alla PUBLIC_HOSTNAME on ohjauskeskuksen isäntänimi:

• openssl s_client -debug -connect ${PUBLIC_HOSTNAME}:9093 -tls1_2 | grep "Turvallista uudelleenneuvottelua tuetaan"

Komennon lähdössä sinun pitäisi nähdä palvelinsertifikaatti sekä seuraavat:

• Secure Renegotiation IS tuettu

Tarkista seuraavasta lokista, että sisäisille palveluille on myönnetty pääsy Kafka-palvelimeenfiles:

• /var/log/kafka/server.log
• /var/log/kafka/kafka-authorizer.log

Ulkoisen asiakasyhteyden vahvistaminen

kafkacat

HUOM: Nämä ohjeet tulee suorittaa asiakastietokoneessa (ei Control Center -palvelimessa).
HUOM: Jos haluat näyttää mittaustiedot, varmista, että vähintään yksi näyttö on käynnissä Ohjauskeskuksessa.

Yhteyden varmentamiseen ja vahvistamiseen ulkoisena asiakkaana on mahdollista käyttää kafkacat-apuohjelmaa, joka asennettiin osiossa "Streaming APIn toimivuuden varmistaminen ohjauskeskuksessa" sivulla 4.
Suorita seuraavat vaiheet:

HUOM: Alla CLIENT_USER on aiemmin määritetty käyttäjä file /etc/kafka/server.properties Ohjauskeskuksessa: eli user_client ja siinä asetettu salasana.
Palvelinpuolen SSL-sertifikaatin allekirjoittamiseen käytetyn CA-juurivarmenteen on oltava asiakkaassa.

Luo a file client.properties seuraavalla sisällöllä:

• security.protocol=SASL_SSL
• ssl.ca.location={PATH_TO_CA_CERT}
• sasl.mechanisms=PLAIN
• sasl.username={CLIENT_USER}
• sasl.password={CLIENT_PASSWORD}

jossa

• {PATH_TO_CA_CERT} on Kafka-välittäjän käyttämän CA-juurivarmenteen sijainti
• {CLIENT_USER} ja {CLIENT_PASSWORD} ovat asiakkaan tunnistetiedot.

Suorita seuraava komento nähdäksesi kafkacatin käyttämän viestin:

• vienti KAFKA_FQDN=
• vie METRICS_TOPIC=paa.public.accounts. .metrics
• kafkacat -b ${KAFKA_FQDN}:9093 -F client.properties -t ${METRICS_TOPIC} -C -e

jossa {METRICS_TOPIC} on Kafka-aiheen nimi etuliitteellä "paa.public.".

HUOMAA: Kafkacatin vanhemmat versiot eivät tarjoa -F-vaihtoehtoa asiakasasetusten lukemiseen kohdasta a file. Jos käytät tällaista versiota, sinun on annettava samat asetukset komentoriviltä kuin alla.

kafkacat -b ${KAFKA_FQDN}:9093 \

• X security.protocol=SASL_SSL \
• X ssl.ca.location={PATH_TO_CA_CERT} \
• X sasl.mechanisms=PLAIN \
• X sasl.username={CLIENT_USER} \
• X sasl.password={CLIENT_PASSWORD} \
• t ${METRICS_TOPIC} -C -e

Yhteyden virheenkorjaus voit käyttää -d-vaihtoehtoa:

Virheenkorjaus kuluttajaviestinnässä
kafkacat -d kuluttaja -b ${KAFKA_FQDN}:9093 -F client.properties -t ${METRICS_TOPIC} -C -e
# Virheenkorjaus välittäjäviestinnässä
kafkacat -d välittäjä -b ${KAFKA_FQDN}:9093 -F client.properties -t ${METRICS_TOPIC} -C -e

Muista tutustua käytössä olevan Kafka-asiakaskirjaston dokumentaatioon, sillä ominaisuudet voivat poiketa client.properties-tiedoston ominaisuuksista.

Viestin muoto
Mittareihin ja metatietoaiheisiin käytetyt viestit sarjoidaan protokollapuskurit (protobuf) -muodossa (katso developers.google.com/protocol-buffers). Näiden viestien skeemat noudattavat seuraavaa muotoa:

Metrics Protobuf Schema

• syntaksi = "proto3";
• tuo "google/protobuf/timestamp.proto";
• paketti paa.streamingapi;
• option go_package = ".;paa_streamingapi";
• viesti Mittarit {
• google.protobuf.Timestamp kertaaamp = 1;
• kartta arvot = 2;
• int32 stream_id = 3;
• }
• /**
• * Metrinen arvo voi olla joko kokonaisluku tai kelluva luku.
• */
• viesti MetricValue {
• oneof type {
• int64 int_val = 1;
• float float_val = 2;
• }
• }

Metadata Protobuf Schema

• syntaksi = "proto3";
• paketti paa.streamingapi;
• option go_package = ".;paa_streamingapi";
• viestin metatiedot {
• int32 stream_id = 1;
• merkkijono virran_nimi = 2;
• kartta tags = 13;
• }

Asiakas Examples

HUOMAA: Nämä komennot on tarkoitettu suoritettavaksi ulkoisessa asiakaskoneessa, esimampkannettavassa tietokoneessa tai vastaavassa, eikä Ohjauskeskuksessa.
HUOMAA: Jotta mittaustiedot näytetään, varmista, että vähintään yksi näyttö on käynnissä Ohjauskeskuksessa.

Ohjauskeskuksen tarball sisältää arkiston paa-streaming-api-client-examples.tar.gz (asiakas-esimamples), joka sisältää example Python-skripti, joka näyttää kuinka Streaming API:ta käytetään.

Client Ex:n asentaminen ja määrittäminenamples
Löydät asiakkaan examples Paragon Active Assurance Control Center -kansiossa:

• vienti CC_VERSION=4.1.0
• cd ./paa-control-center_${CC_VERSION}
• ls paa-streaming-api-client-examples*

Voit asentaa client-exampulkoisella asiakastietokoneellasi, toimi seuraavasti:

• # Luo hakemisto esim. asiakkaan sisällön purkamiseksiamples tarball
• mkdir paa-streaming-api-client-examples
• # Pura asiakkaan sisältö esimamples tarball
• tar xzf paa-streaming-api-client-examples.tar.gz -C paa-streaming-api-client-examples
• # Siirry äskettäin luotuun hakemistoon
• cd paa-streaming-api-client-examples

asiakas-examples vaatii Dockerin ajamiseen. Lataukset ja asennusohjeet Dockerille löytyvät osoitteesta https://docs.docker.com/engine/install.

Käyttämällä Client Examples
Asiakas-examples-työkalut voivat toimia joko perus- tai edistyneessä tilassa exampvähemmän monimutkaisia. Molemmissa tapauksissa on myös mahdollista suorittaa examples kokoonpanolla file sisältää lisäominaisuuksia asiakaspuolen mukauttamiseen.

Perustila
Perustilassa mittarit ja niiden metatiedot suoratoistetaan erikseen. Tätä tarkoitusta varten asiakas kuuntelee jokaista ulkopuolista käytettävää Kafka-aihetta ja tulostaa vastaanotetut viestit konsoliin.
Aloita perus-examples, juokse:

• build.sh run-basic –kafka-brokers localhost:9092 –tili ACCOUNT_SHORTNAME

jossa ACCOUNT_SHORTNAME on sen tilin lyhyt nimi, jolta haluat saada tiedot.
Lopettaakseen example, paina Ctrl + C. (Suorituksen pysähtymiseen saattaa kulua pieni viive, koska asiakas odottaa aikakatkaisutapahtumaa.)

Edistynyt tila

HUOM: Mittarit näkyvät vain HTTP-näytöissä, jotka ovat käynnissä Ohjauskeskuksessa.

Suoritus edistyneessä tilassa näyttää korrelaation mittareiden ja metatietoviestien välillä. Tämä on
mahdollista, koska jokaisessa metriikkaviestissä on stream id -kenttä, joka viittaa vastaavaan metatietoviestiin.
Suorittaaksesi edistyneen examples, juokse:

• build.sh run-advanced –kafka-brokers localhost:9092 –tili ACCOUNT_SHORTNAME

jossa ACCOUNT_SHORTNAME on sen tilin lyhyt nimi, jolta haluat saada tiedot.
Lopettaakseen example, paina Ctrl + C. (Suorituksen pysähtymiseen saattaa kulua pieni viive, koska asiakas odottaa aikakatkaisutapahtumaa.)

Lisäasetukset
On mahdollista ajaa examples asiakkaan lisämäärityksellä käyttämällä -config-file vaihtoehto, jota seuraa a file nimi, joka sisältää ominaisuuksia muodossa avain=arvo.

• build.sh run-advanced \
• –kafka-brokers localhost:9092 \
• –tili ACCOUNT_SHORTNAME \
• -kokoonpano-file client_config.properties

HUOM: Kaikki fileYllä olevassa komennossa viitattujen tiedostojen on sijaittava nykyisessä hakemistossa, ja niihin viitataan käyttämällä vain suhteellisia polkuja. Tämä koskee sekä -config-file argumenttia ja kaikkiin kokoonpanon merkintöihin file jotka kuvaavat file sijainnit.

Ulkoisen asiakkaan todennuksen vahvistaminen
Asiakkaan todennuksen vahvistaminen Ohjauskeskuksen ulkopuolelta käyttämällä client-exiäamples, suorita seuraavat vaiheet:

Vaihda Paragon Active Assurance Control Center -kansiosta paa-streaming-api-client-ex.amples-kansio:

cd paa-streaming-api-client-examples

• Kopioi CA-juurivarmenne ca-cert nykyiseen hakemistoon.
• Luo client.properties file seuraavalla sisällöllä:

security.protocol=SASL_SSL ssl.ca.location=ca-cert
sasl.mechanism=PLAIN
sasl.username={CLIENT_USER}
sasl.password={CLIENT_PASSWORD}

missä {CLIENT_USER} ja {CLIENT_PASSWORD} ovat asiakkaan käyttäjätiedot.

Suorita perus examples:

• vienti KAFKA_FQDN=
• build.sh run-basic –kafka-brokers ${KAFKA_FQDN}:9093 \
• –tili ACCOUNT_SHORTNAME
• -kokoonpano-file client.properties

jossa ACCOUNT_SHORTNAME on sen tilin lyhyt nimi, jolta haluat saada tiedot.

Suorita edistynyt examples:

• vienti KAFKA_FQDN=
• build.sh run-advanced –kafka-brokers ${KAFKA_FQDN}:9093 \
• –tili ACCOUNT_SHORTNAME
• -kokoonpano-file client.properties

Liite

Tässä liitteessä kuvataan kuinka luodaan:

• avainsäilö file Kafka Broker SSL -varmenteen tallentamiseen
• luottamuskauppa file Kafka-välittäjävarmenteen allekirjoittamiseen käytetyn varmenteen myöntäjän (CA) juurivarmenteen tallentamiseen.

Kafka Broker -sertifikaatin luominen
Varmenteen luominen todellisen varmentajan avulla (suositus)
On suositeltavaa hankkia todellinen SSL-varmenne luotettavalta CA:lta.
Kun olet valinnut varmentajan, kopioi sen CA-juurivarmenteen ca-cert file omalle polullesi alla olevan kuvan mukaisesti:

• vie CA_PATH=~/my-ca
• mkdir ${CA_PATH}
• cp ca-cert ${CA_PATH}

Luo oma varmenteen myöntäjä

HUOMAA: Normaalisti sinun tulee allekirjoittaa varmenne oikealla varmentajalla. katso edellinen alakohta. Seuraava on vain example.

Täällä luomme oman varmenteen myöntäjän (CA) juurivarmenteen file voimassa 999 päivää (ei suositella tuotannossa):

• # Luo hakemisto CA:n tallentamista varten
• vie CA_PATH=~/my-ca
• mkdir ${CA_PATH}
• # Luo CA-varmenne
• openssl req -uusi -x509 -avain ${CA_PATH}/ca-avain -ulos ${CA_PATH}/ca-cert -päivää 999

Client Truststoren luominen
Nyt voit luoda luottamuskaupan file joka sisältää yllä luodun ca-sertifikaatin. Tämä file tarvitsee Kafka-asiakas, joka käyttää suoratoistosovellusliittymää:

• keytool -keystore kafka.client.truststore.jks \
  • alias CARoot \
  • maahantuoja -file ${CA_PATH}/ca-sertifikaatti

Nyt kun CA-varmenne on luottamuskaupassa, asiakas luottaa kaikkiin sillä allekirjoitettuihin varmenteisiin.
Sinun pitäisi kopioida file kafka.client.truststore.jks tunnettuun paikkaan asiakastietokoneellasi ja osoita sitä asetuksissa.

Avainsäilön luominen Kafka Brokerille
Luo Kafka Broker SSL -varmenne ja sitten avainsäilö kafka.server.keystore.jks seuraavasti:

Luodaan SSL-sertifikaatti
Alla 999 on avainsäilön voimassaolopäivien lukumäärä, ja FQDN on asiakkaan täysin hyväksytty toimialueen nimi (solmun julkinen isäntänimi).

HUOMAA: On tärkeää, että FQDN vastaa täsmälleen sitä isäntänimeä, jota Kafka-asiakas käyttää muodostaessaan yhteyden ohjauskeskukseen.

• sudo mkdir -p /var/ssl/private
• sudo chown -R $USER: /var/ssl/private
• cd /var/ssl/private
• vienti FQDN= keytool -keystore kafka.server.keystore.jks \
• – aliaspalvelin \
• – voimassaoloaika 999 \
• – genkey -keyalg RSA -ext SAN=dns:${FQDN}

Luo varmenteen allekirjoituspyyntö ja tallenna se file nimeltä varmennepalvelinpyyntö:

• keytool -keystore kafka.server.keystore.jks \
  • – aliaspalvelin \
  • - certreq \
  • – file varmennepalvelin-pyyntö

Sinun pitäisi nyt lähettää file cert-server-request varmenteen myöntäjälle (CA), jos käytät oikeaa. Sitten he palauttavat allekirjoitetun todistuksen. Kutsumme tähän jäljempänä varmennepalvelimen allekirjoittamana.

SSL-varmenteen allekirjoittaminen itse luodun CA-varmenteen avulla

HUOM: Oman CA:n käyttöä ei suositella tuotantojärjestelmässä.

Allekirjoita varmenne CA:ta käyttäen file cert-server-request, joka tuottaa allekirjoitetun varmenteen cert-server-signed. Katso alempaa; ca-salasana on CA-varmennetta luotaessa asetettu salasana.

• cd /var/ssl/private openssl x509 -req \
  • – CA ${CA_PATH}/ca-cert \
  • – CA-avain ${CA_PATH}/ca-avain \
  • – varmennepalvelinpyynnössä \
  • – ulos varmennepalvelimen allekirjoittama \
  • - päivää 999 -CAluo sarja \
  • – passin pass:{ca-password}

Allekirjoitetun varmenteen tuonti Keystoreen

Tuo ca-cert-juurivarmenne avainsäilöön:

• keytool -keystore kafka.server.keystore.jks \
  • – alias ca-cert \
  • - tuonti \
  • – file ${CA_PATH}/ca-sertifikaatti

Tuo allekirjoitettu varmenne, jota kutsutaan varmennepalvelimen allekirjoitukseksi:

• keytool -keystore kafka.server.keystore.jks \
  • – aliaspalvelin \
  • - tuonti \
  • – file varmennepalvelimen allekirjoittama

The file kafka.server.keystore.jks tulee kopioida tunnettuun sijaintiin Control Center -palvelimessa ja viitata sitten tiedostoon /etc/kafka/server.properties.

Streaming API:n käyttäminen

TÄSSÄ OSIOSSA

• Yleistä | 20
• Kafka Aiheiden nimet | 21
• Examples of Streaming APIn käyttäminen | 21

Kenraali
Suoratoistosovellusliittymä hakee sekä testi- että valvontatiedot. Ei ole mahdollista erottaa yhtä näistä luokista.
Striimaussovellusliittymä ei nouta tietoja komentosarjapohjaisista testeistä (ne, joita ohjauskeskuksen graafisessa käyttöliittymässä edustaa suorakulmio palan sijaan), kuten Ethernet-palvelun aktivointitesteistä ja läpinäkyvyystesteistä.

Kafka-aiheiden nimet
Kafka-aiheiden nimet suoratoistosovellusliittymälle ovat seuraavat, missä %s on ohjauskeskuksen tilin lyhyt nimi (ilmoitetaan tiliä luotaessa):

• const (
• exporterName = "kafka"
• metadataTopicTpl = "paa.public.accounts.%s.metadata" metricsTopicTpl = "paa.public.accounts.%s.metrics" )

ExampStreaming API:n käyttäminen
Exampseuraavat löytyvät tiedostosta tarball paa-streaming-api-client-examples.tar.gz, joka sisältyy Control Center -tarballiin.
Ensinnäkin on perus example osoittaa, kuinka mittarit ja niiden metatiedot suoratoistetaan erikseen ja tulostetaan yksinkertaisesti vastaanotetut viestit konsoliin. Voit suorittaa sen seuraavasti:

• sudo ./build.sh run-basic –kafka-brokers localhost:9092 –tili ACCOUNT_SHORTNAME

Siellä on myös edistyneempi example, jossa mittarit ja metatietoviestit korreloivat. Käytä tätä komentoa suorittaaksesi sen:

• sudo ./build.sh run-advanced –kafka-brokers localhost:9092 –tili ACCOUNT_SHORTNAME

Sinun on käytettävä sudoa suorittaaksesi Docker-komentoja, kuten yllä olevia. Valinnaisesti voit seurata Linuxin asennuksen jälkeisiä vaiheita voidaksesi suorittaa Docker-komentoja ilman sudoa. Lisätietoja on osoitteessa docs.docker.com/engine/install/linux-postinstall.

Juniper Networks, Juniper Networksin logo, Juniper ja Junos ovat Juniper Networks, Inc:n rekisteröityjä tavaramerkkejä Yhdysvalloissa ja muissa maissa. Kaikki muut tavaramerkit, palvelumerkit, rekisteröidyt merkit tai rekisteröidyt palvelumerkit ovat vastaavien omistajiensa omaisuutta. Juniper Networks ei ota vastuuta tämän asiakirjan epätarkkuuksista. Juniper Networks pidättää oikeuden muuttaa, muokata, siirtää tai muutoin tarkistaa tätä julkaisua ilman erillistä ilmoitusta. Copyright © 2023 Juniper Networks, Inc. Kaikki oikeudet pidätetään.

Asiakirjat / Resurssit

Juniper NETWORKS Streaming API -ohjelmisto [pdfKäyttöopas Streaming API -ohjelmisto, API-ohjelmisto, ohjelmisto

Viitteet

• Käyttöopas