Fabric-valvontakeskuksen määrittäminen

Microsoft Fabric Workload Development Kitin valvontakeskus on keskitetty seurantakeskus. Valvontakeskus on suunniteltu Fabric-käyttäjille kohteen taustatöiden seurantaan. Lisätietoja on kohdassa Valvontakeskuksen käyttäminen.

Tausta

Tässä osiossa kuvataan taustatoteutetun käyttöönoton määrittäminen valvontakeskukselle.

JobScheduler Kohteen luettelotiedoston ominaisuuden määrittäminen

Jotta työtuki voidaan ottaa käyttöön, kohteen on määritettävä tukemansa työtyypit. JobScheduler Lisää ominaisuus kohteen luettelotiedostoon. - JobScheduler ominaisuus mahdollistaa Fabric-hallittujen töiden työstämisen kohteissasi.

Seuraavassa taulukossa on yleiskatsaus tuetuista JobScheduler määritysominaisuksista:

Ominaisuus	Kuvaus	Mahdolliset arvot
OnDemandJobDeduplicateOptions	Määrittää pyydettäessä tehtäviä kohdetöitä koskevan deduplication-asetuksen.	- None: Älä tue työtä. - PerArtifact: Varmista, että samalle kohteelle ja työtyypille on vain yksi aktiivinen työ. - PerUser: Varmista, että samalle käyttäjälle ja kohteelle suoritetaan vain yksi aktiivinen työ.
ScheduledJobDeduplicateOptions	Määrittää pyydettäessä tehtäviä kohdetöitä koskevan deduplication-asetuksen.	- None: Älä tue työtä. - PerArtifact: Varmista, että samalle kohteelle ja työtyypille on vain yksi aktiivinen työ. - PerUser: Varmista, että samalle käyttäjälle ja kohteelle suoritetaan vain yksi aktiivinen työ.
ItemJobTypes	Luettelo työtyypeistä, joilla on määritetyt ominaisuudet.	- Name: Työtyypin nimi, joka on täysin riippumattoman ohjelmistotoimittajan (ISV) mukautettavissa.

Kuormituksen ohjelmointirajapintojen käyttöönotto

Kuormituksen on otettava käyttöön töiden ohjelmointirajapinnat, jotka on määritetty Swagger-määrityksessä , jotta työt voidaan integroida.

Työpaikkoihin liittyy kolme Fabric-ohjelmointirajapintaa:

---

Käynnistä työn esiintymä

Päätepiste: POST /workspaces/{workspaceId}/items/{itemType}/{itemId}/jobTypes/{jobType}/instances/{jobInstanceId}

Tätä ohjelmointirajapintaa kutsutaan työn suorittamisen aloittamiseksi.

• Vastaus: Ohjelmointirajapinnan pitäisi palauttaa tila, joka 202 Accepted ilmaisee, että järjestelmä ajoitti työn onnistuneesti.

---

Työesiintymätilan noutaminen

Päätepiste: GET /workspaces/{workspaceId}/items/{itemType}/{itemId}/jobTypes/{jobType}/instances/{jobInstanceId}

Fabric käyttää kyselymekanismia työn esiintymän tilan seuraamiseen. Tätä ohjelmointirajapintaa kutsutaan joka minuutti, kun työn esiintymä on meneillään sen tilan tarkistamiseksi. Kysely pysäytetään, kun työ on suoritettu, joko onnistuneesti tai epäonnistumisen vuoksi.

• Vastaus: Ohjelmointirajapinnan tulisi palauttaa 200 OK tila ja nykyisen työesiintymän tila. Vastauksen tulee sisältää työn tila, alkamis- ja päättymisajat sekä työn epäonnistumisen virheet.

  Tuetut työn tilat:

  • NotStarted
  • InProgress
  • Completed
  • Failed
  • Cancelled

  Tärkeää: Vaikka työ epäonnistuu, tämän ohjelmointirajapinnan pitäisi palauttaa 200 OK tila ja Failed työn tila.

---

Työn esiintymän peruuttaminen

Päätepiste: POST /workspaces/{workspaceId}/items/{itemType}/{itemId}/jobTypes/{jobType}/instances/{jobInstanceId}/cancel

Kutsu tätä ohjelmointirajapintaa jatkuvan työesiintymän peruuttamiseksi.

• Vastaus: Ohjelmointirajapinnan tulisi palauttaa 200 OK tila ja nykyinen Työesiintymän tila. Vastauksen tulee sisältää työn tila, alkamis- ja päättymisajat sekä työn epäonnistumisen virheet.

---

Lisätietoja

Työpaikkojen tyhjänsijainnin määrä:

Fabric-alusta on merkinnyt työn "kuolleeksi kirjaimeksi", jos se ei ala 2 tunnin kuluessa.

Esimerkki toteutuksesta

Jos haluat toteuttaa nämä ohjelmointirajapinnat esimerkiksi, katso JobsControllerImpl.cs mallisäilöstä.

Edusta

Tässä osiossa kuvataan, miten voit määrittää edustan toteutuksen valvontakeskukselle.

Työn suorittaminen Fabric-käyttöliittymässä

Kun integroit työt taustakohteeseen, käyttäjät voivat aloittaa töiden suorittamisen.

Käyttäjillä on kaksi vaihtoehtoa suorittaa töitä Fabricissa:

• Valvomaton ajoitettu työ. Käyttäjä määrittää tämän asetuksen suoritettavaksi säännöllisin väliajoin jaetun Fabric-ajoitustoiminnon avulla.
• Tarvittaessa käyttämällä kuormituskäyttöliittymää - ja laajennusasiakas-SDK:n kanssa.

Fabric-ajoitustoiminnon käyttökokemus käyttöliittymästä

• Aloituskohdan asetukset:

  • Käytä pikavalikon aikataulua.

    

  • Käytä kohdetta workloadClient.itemSettings.open, jossa valittu asetustunnus on Schedule.

• Asettelu

  

  1. Viimeisimmän onnistuneen päivityksen ajan ja seuraavan päivityksen ajankohta.
  2. Päivitä-painike.
  3. Kohteen ajoitusasetukset.

Käyttöönotto

Vaihe 1: Lisää aikataulun pikavalikkokohde

Jos haluat näyttää kohteen pikavalikon Schedule-painikkeen , lisää uusi merkintä kohteen edustan luettelotiedoston contextMenuItems ominaisuuteen:

{
    "name": "schedule"
}

Vaihe 2: Kohteen aikatauluasetusten lisääminen

Lisää uusi schedule merkintä kohdeasetusten ominaisuuteen edustan luettelotiedostossa:

"schedule": {
    "itemJobType": "ScheduledJob",
    "refreshType": "Refresh"
}

• itemJobType: Kohdetyön tyyppi, joka on määritetty kohdetyön määritelmän XML-tiedostossa.
• refreshType: Määrittää Päivitä-painikkeen näytön. Valitse kolmesta vaihtoehdosta: Käytä Refresh ja Run ota päivityspainike ja näyttönimi käyttöön tai poista None Päivitä-painike käytöstä.

Jobs JavaScript -ohjelmointirajapinnat

Valvomattomien ajoitettujen töiden lisäksi kuormitus voi suorittaa työn pyydettäessä tai jopa aloittaa ajoitetun työn pyydettäessä. Olemme luoneet laajennusasiakkaaseen joukon ohjelmointirajapintoja:

• Ajoitettujen töiden ohjelmointirajapinnat:

  • getItemScheduledJobs(objectId: string): Promise<ItemSchedule>
  • createItemScheduledJobs(createItemScheduledJobs: CreateItemScheduleParams): Promise<ItemSchedule>
  • updateItemScheduledJobs(updateItemScheduleParams: UpdateItemScheduleParams): Promise<ItemSchedule>

• Tietyn työesiintymän ohjelmointirajapinnat:

  • runItemJob(jobParams: RunItemJobParams): Promise<ItemJobInstance>
  • cancelItemJob(jobParams: CancelItemJobParams): Promise<CancelItemJobResult>
  • getItemJobHistory(getHistoryParams: GetItemJobHistoryParams): Promise<ItemJobHistory>

Muistiinpano

getItemJobHistory palauttaa työn, jonka tila on tällä hetkellä Fabricissa. Koska Fabric on tällä hetkellä riippuvainen pelkästään kyselyistä, ota huomioon, että tila ei ehkä ole ajan tasalla. Jos edellytät käyttöliittymän heijastavan mahdollisimman tarkkaa tilaa, suosittelemme, että saat tilan suoraan taustasta.

Integrointi valvontakeskuksen kanssa

Kun tiedot ovat valmiita, kohdetyöt näkyvät automaattisesti valvontakeskuksessa. Seuraava vaihe on lisätä kohdetyyppi suodatinruutuun ja määrittää ja toteuttaa käytettävissä olevia toimintoja, joita käyttäjä voi suorittaa töille.

Ota kohteesi käyttöön valvontakeskuksen suodatinruudussa

Jos haluat lisätä kohteesi suodatinruutuun, määritä uusi ominaisuus kohteen edustan luettelotiedostossa ja määritä sen arvoksi supportedInMonitoringHub true.

Integroi työn pikatoimintojen kanssa

Käyttäjä voi suorittaa työlle joukon toimintoja, kuten peruuttaa, yrittää uudelleen ja hakea tietoja.

Kuormitustiimi päättää, minkä ominaisuuden he haluavat ottaa käyttöön, määrittämällä ominaisuuden itemJobConfig kohteen edustan luettelotiedostoon. Jos sitä ei ole määritetty, kuvake ei ole näkyvissä.

Esimerkkikohteeseen lisätty määritys, joka tukee kaikkia työtoimintoja, näkyy myöhemmin tässä osiossa.

Kun käyttäjä valitsee mallikohdetyön Peruuta-kuvakkeen , kutsumme annettua toimintoa item.job.cancel. Kuormitus toteuttaa laajennusta työyhteyteen Fabric.WorkloadSample liittyvän kontekstin, jotta työ todella peruutetaan.

Fabric-ympäristö odottaa myös tämän toiminnon vastauksen ilmoittavan käyttäjille tulokset.

"itemJobActionConfig": {
    "registeredActions": {
        "detail": {
            "extensionName": "Fabric.WorkloadSample",
                "action": "item.job.detail"
        },
        "cancel": {
            "extensionName": "Fabric.WorkloadSample",
                "action": "item.job.cancel"
        },
        "retry": {
            "extensionName": "Fabric.WorkloadSample",
                "action": "item.job.retry"
        }
    }
}

Työn tiedot -ruutu

Kun kuormitustiimi rekisteröi toiminnon yksityiskohtaisia tietoja varten, Fabric odottaa kuormitustoiminnon palauttavan tiedot tietyssä muodossa, jotta Fabric voi näyttää nämä tiedot sivupaneelissa.

Tällä hetkellä tuetaan vain teksti - tai hyperlinkkimuotoisia avain-/arvopareja.

• Esimerkki työtoimintojen käsittelystä on mallisäilön kohdassa index.worker.ts. Etsi tiedostosta toimintoja, joiden alussa on item.job.

Viimeaikaiset suoritukset

Sen lisäksi, että Fabric näyttää työn tilan valvontakeskuksessa, se tarjoaa jaetun käyttäjäkokemuksen, joka näyttää tietyn kohteen viimeaikaiset suoritukset.

Aloituspisteet:

• Pikavalikko>Viimeisimmät suoritukset

  

• :n käyttäminen workloadClient.itemRecentRuns.open.

Käyttöönotto

Vaihe 1: Pikavalikon kohteen lisääminen recentRuns

Jos haluat näyttää Viimeisimmät suoritukset -painikkeen kohdevalikossa, lisää uusi merkintä contextMenuItems kohteen edustan luettelotiedoston ominaisuuteen.

Esimerkki:

{
    "name": "recentruns"
}

Vaihe 2: Kohteen recentRun asetusten lisääminen

Lisää uusi recentRun merkintä kohdeasetusten ominaisuuteen edustan luettelotiedostossa.

Esimerkki:

"recentRun": {
     "useRecentRunsComponent": true,
}

Töiden integrointi mallikohteen valintanauhassa

Käyttöliittymän kuormitusmallin osana lisäsimme kohteen valintanauhaan osan, joka on varattu töille.

Esimerkki tämän valintanauhan käyttöönottotavan kohdasta KohdeTabToolbar.tsx mallisäilössä.

Liittyvä sisältö

• Valvontakeskuksen käyttäminen