ਗ੍ਰਾਫਾਨਾ ਲਈ ਇੱਕ ਪਲੱਗਇਨ ਦਾ ਵਿਕਾਸ: ਵੱਡੇ ਸ਼ਾਟਸ ਦਾ ਇਤਿਹਾਸ

ਸਤਿ ਸ੍ਰੀ ਅਕਾਲ ਸਾਰਿਆਂ ਨੂੰ! ਕੁਝ ਮਹੀਨੇ ਪਹਿਲਾਂ, ਅਸੀਂ ਆਪਣਾ ਨਵਾਂ ਓਪਨ-ਸੋਰਸ ਪ੍ਰੋਜੈਕਟ, ਕੁਬਰਨੇਟਸ ਨਿਗਰਾਨੀ ਲਈ ਇੱਕ ਗ੍ਰਾਫਾਨਾ ਪਲੱਗਇਨ, ਉਤਪਾਦਨ ਵਿੱਚ ਲਾਂਚ ਕੀਤਾ ਸੀ। DevOpsProdigy KubeGraf ਵੱਲੋਂ ਹੋਰਪਲੱਗਇਨ ਸਰੋਤ ਕੋਡ ਇਸ ਵਿੱਚ ਉਪਲਬਧ ਹੈ GitHub 'ਤੇ ਜਨਤਕ ਭੰਡਾਰਇਸ ਲੇਖ ਵਿੱਚ, ਅਸੀਂ ਤੁਹਾਡੇ ਨਾਲ ਪਲੱਗਇਨ ਕਿਵੇਂ ਬਣਾਇਆ, ਵਰਤੇ ਗਏ ਟੂਲਸ, ਅਤੇ ਵਿਕਾਸ ਦੌਰਾਨ ਸਾਨੂੰ ਆਈਆਂ ਮੁਸ਼ਕਲਾਂ ਦੀ ਕਹਾਣੀ ਸਾਂਝੀ ਕਰਨਾ ਚਾਹੁੰਦੇ ਹਾਂ। ਆਓ ਸ਼ੁਰੂ ਕਰੀਏ!

ਭਾਗ 0 - ਜਾਣ-ਪਛਾਣ: ਅਸੀਂ ਇੱਥੇ ਕਿਵੇਂ ਪਹੁੰਚੇ?

ਗ੍ਰਾਫਾਨਾ ਲਈ ਆਪਣਾ ਪਲੱਗਇਨ ਲਿਖਣ ਦਾ ਵਿਚਾਰ ਸਾਨੂੰ ਅਚਾਨਕ ਹੀ ਆਇਆ। ਸਾਡੀ ਕੰਪਨੀ 10 ਸਾਲਾਂ ਤੋਂ ਵੱਧ ਸਮੇਂ ਤੋਂ ਵੱਖ-ਵੱਖ ਜਟਿਲਤਾ ਵਾਲੇ ਵੈੱਬ ਪ੍ਰੋਜੈਕਟਾਂ ਦੀ ਨਿਗਰਾਨੀ ਕਰ ਰਹੀ ਹੈ। ਇਸ ਸਮੇਂ ਦੌਰਾਨ, ਅਸੀਂ ਵੱਖ-ਵੱਖ ਨਿਗਰਾਨੀ ਪ੍ਰਣਾਲੀਆਂ ਦੀ ਵਰਤੋਂ ਕਰਦੇ ਹੋਏ ਮੁਹਾਰਤ, ਦਿਲਚਸਪ ਕੇਸ ਅਧਿਐਨ ਅਤੇ ਅਨੁਭਵ ਦਾ ਭੰਡਾਰ ਇਕੱਠਾ ਕੀਤਾ ਹੈ। ਕਿਸੇ ਸਮੇਂ, ਅਸੀਂ ਸੋਚਿਆ: "ਕੀ ਕੁਬਰਨੇਟਸ ਦੀ ਨਿਗਰਾਨੀ ਲਈ ਕੋਈ ਜਾਦੂਈ ਟੂਲ ਹੈ ਜਿਸਨੂੰ ਤੁਸੀਂ, ਜਿਵੇਂ ਕਿ ਉਹ ਕਹਿੰਦੇ ਹਨ, 'ਇਸਨੂੰ ਸੈੱਟ ਕਰੋ ਅਤੇ ਭੁੱਲ ਜਾਓ'"? ਕੁਦਰਤੀ ਤੌਰ 'ਤੇ, ਪ੍ਰੋਮੀਥੀਅਸ + ਗ੍ਰਾਫਾਨਾ ਕੰਬੋ ਲੰਬੇ ਸਮੇਂ ਤੋਂ K8S ਨਿਗਰਾਨੀ ਲਈ ਉਦਯੋਗ ਦਾ ਮਿਆਰ ਰਿਹਾ ਹੈ। ਇਸ ਸਟੈਕ ਲਈ ਤਿਆਰ-ਕੀਤੇ ਟੂਲਸ ਦੀ ਇੱਕ ਵਿਸ਼ਾਲ ਸ਼੍ਰੇਣੀ ਮੌਜੂਦ ਹੈ, ਜਿਸ ਵਿੱਚ ਪ੍ਰੋਮੀਥੀਅਸ-ਓਪਰੇਟਰ, ਕੁਬਰਨੇਟਸ-ਮਿਕਸਿਨ ਡੈਸ਼ਬੋਰਡ ਸੂਟ, ਅਤੇ ਗ੍ਰਾਫਾਨਾ-ਕੁਬਰਨੇਟਸ-ਐਪ ਸ਼ਾਮਲ ਹਨ।

grafana-kubernetes-app ਪਲੱਗਇਨ ਸਾਡੇ ਲਈ ਸਭ ਤੋਂ ਦਿਲਚਸਪ ਵਿਕਲਪ ਜਾਪਦਾ ਸੀ, ਪਰ ਇਹ ਇੱਕ ਸਾਲ ਤੋਂ ਵੱਧ ਸਮੇਂ ਤੋਂ ਸਮਰਥਿਤ ਨਹੀਂ ਹੈ ਅਤੇ ਇਸ ਤੋਂ ਇਲਾਵਾ, ਇਹ node-exporter ਅਤੇ kube-state-metrics ਦੇ ਨਵੇਂ ਸੰਸਕਰਣਾਂ ਨਾਲ ਕੰਮ ਨਹੀਂ ਕਰਦਾ ਹੈ। ਕਿਸੇ ਸਮੇਂ, ਅਸੀਂ ਫੈਸਲਾ ਕੀਤਾ, "ਕਿਉਂ ਨਾ ਆਪਣਾ ਹੱਲ ਖੁਦ ਬਣਾਈਏ?"

ਅਸੀਂ ਆਪਣੇ ਪਲੱਗਇਨ ਵਿੱਚ ਕਿਹੜੇ ਵਿਚਾਰਾਂ ਨੂੰ ਲਾਗੂ ਕਰਨ ਦਾ ਫੈਸਲਾ ਕੀਤਾ?

• ਐਪਲੀਕੇਸ਼ਨ ਮੈਪ ਵਿਜ਼ੂਅਲਾਈਜ਼ੇਸ਼ਨ: ਇੱਕ ਕਲੱਸਟਰ ਵਿੱਚ ਐਪਲੀਕੇਸ਼ਨਾਂ ਦੀ ਇੱਕ ਸੁਵਿਧਾਜਨਕ ਪ੍ਰਤੀਨਿਧਤਾ, ਨਾਮ-ਸਥਾਨਾਂ, ਤੈਨਾਤੀਆਂ, ਆਦਿ ਦੁਆਰਾ ਸਮੂਹਬੱਧ;
• "ਤੈਨਾਤੀ - ਸੇਵਾ (+ਪੋਰਟ)" ਕਿਸਮ ਦੇ ਕਨੈਕਸ਼ਨਾਂ ਦਾ ਵਿਜ਼ੂਅਲਾਈਜ਼ੇਸ਼ਨ।
• ਕਲੱਸਟਰ ਨੋਡਾਂ ਵਿੱਚ ਕਲੱਸਟਰ ਐਪਲੀਕੇਸ਼ਨਾਂ ਦੀ ਵੰਡ ਦਾ ਦ੍ਰਿਸ਼ਟੀਕੋਣ।
• ਕਈ ਸਰੋਤਾਂ ਤੋਂ ਮੈਟ੍ਰਿਕਸ ਅਤੇ ਜਾਣਕਾਰੀ ਇਕੱਠੀ ਕਰਨਾ: ਪ੍ਰੋਮੀਥੀਅਸ ਅਤੇ k8s API ਸਰਵਰ।
• ਬੁਨਿਆਦੀ ਢਾਂਚੇ (CPU ਸਮਾਂ, ਮੈਮੋਰੀ, ਡਿਸਕ ਸਬਸਿਸਟਮ, ਨੈੱਟਵਰਕ ਦੀ ਵਰਤੋਂ) ਅਤੇ ਐਪਲੀਕੇਸ਼ਨ ਲਾਜਿਕ ਦੋਵਾਂ ਦੀ ਨਿਗਰਾਨੀ - ਪੌਡਾਂ ਦੀ ਸਿਹਤ ਸਥਿਤੀ, ਉਪਲਬਧ ਪ੍ਰਤੀਕ੍ਰਿਤੀਆਂ ਦੀ ਗਿਣਤੀ, ਅਤੇ ਲਾਈਵਨੈੱਸ/ਤਿਆਰੀ ਟੈਸਟਾਂ ਦੀ ਪ੍ਰਗਤੀ ਬਾਰੇ ਜਾਣਕਾਰੀ।

ਭਾਗ 1: ਗ੍ਰਾਫਾਨਾ ਪਲੱਗਇਨ ਕੀ ਹੈ?

ਤਕਨੀਕੀ ਦ੍ਰਿਸ਼ਟੀਕੋਣ ਤੋਂ, ਗ੍ਰਾਫਾਨਾ ਲਈ ਇੱਕ ਪਲੱਗਇਨ ਇੱਕ ਐਂਗੁਲਰ ਕੰਟਰੋਲਰ ਹੈ ਜੋ ਗ੍ਰਾਫਾਨਾ ਦੀ ਡੇਟਾ ਡਾਇਰੈਕਟਰੀ ਵਿੱਚ ਸਟੋਰ ਕੀਤਾ ਜਾਂਦਾ ਹੈ (/var/ਗ੍ਰਾਫਾਨਾ/ਪਲੱਗਇਨ/ /dist/module.js) ਅਤੇ ਇੱਕ SystemJS ਮੋਡੀਊਲ ਦੇ ਤੌਰ ਤੇ ਲੋਡ ਕੀਤਾ ਜਾ ਸਕਦਾ ਹੈ। ਇਸ ਡਾਇਰੈਕਟਰੀ ਵਿੱਚ ਇੱਕ plugin.json ਫਾਈਲ ਵੀ ਹੋਣੀ ਚਾਹੀਦੀ ਹੈ, ਜਿਸ ਵਿੱਚ ਤੁਹਾਡੇ ਪਲੱਗਇਨ ਬਾਰੇ ਸਾਰਾ ਮੈਟਾਡੇਟਾ ਸ਼ਾਮਲ ਹੁੰਦਾ ਹੈ: ਨਾਮ, ਸੰਸਕਰਣ, ਪਲੱਗਇਨ ਕਿਸਮ, ਰਿਪੋਜ਼ਟਰੀ/ਵੈੱਬਸਾਈਟ/ਲਾਇਸੈਂਸ ਲਿੰਕ, ਨਿਰਭਰਤਾਵਾਂ, ਅਤੇ ਹੋਰ।

ਮੋਡੀਊਲ.ਟੀ.ਐੱਸ

ਪਲੱਗਇਨ.ਜੇਸਨ

ਜਿਵੇਂ ਕਿ ਤੁਸੀਂ ਸਕ੍ਰੀਨਸ਼ੌਟ ਵਿੱਚ ਦੇਖ ਸਕਦੇ ਹੋ, ਅਸੀਂ plugin.type = app ਨਿਰਧਾਰਤ ਕੀਤਾ ਹੈ। ਇਹ ਇਸ ਲਈ ਹੈ ਕਿਉਂਕਿ ਗ੍ਰਾਫਾਨਾ ਲਈ ਤਿੰਨ ਤਰ੍ਹਾਂ ਦੇ ਪਲੱਗਇਨ ਹਨ:

ਪੈਨਲ ਨੂੰ: ਪਲੱਗਇਨ ਦੀ ਸਭ ਤੋਂ ਆਮ ਕਿਸਮ - ਇਹ ਕੁਝ ਖਾਸ ਮੈਟ੍ਰਿਕਸ ਦੀ ਕਲਪਨਾ ਕਰਨ ਲਈ ਇੱਕ ਪੈਨਲ ਹੈ ਅਤੇ ਵੱਖ-ਵੱਖ ਡੈਸ਼ਬੋਰਡ ਬਣਾਉਣ ਲਈ ਵਰਤਿਆ ਜਾਂਦਾ ਹੈ।
ਡਾਟਾ ਸਰੋਤ: ਕਿਸੇ ਵੀ ਡੇਟਾ ਸਰੋਤ ਨਾਲ ਇੱਕ ਪਲੱਗਇਨ ਕਨੈਕਟਰ (ਉਦਾਹਰਨ ਲਈ, ਪ੍ਰੋਮੀਥੀਅਸ-ਡਾਟਾਸੋਰਸ, ਕਲਿਕਹਾਊਸ-ਡਾਟਾਸੋਰਸ, ਇਲੈਸਟਿਕ ਸਰਚ-ਡਾਟਾਸੋਰਸ)।
ਐਪ: ਇੱਕ ਪਲੱਗਇਨ ਜੋ ਤੁਹਾਨੂੰ ਗ੍ਰਾਫਾਨਾ ਦੇ ਅੰਦਰ ਆਪਣੀ ਖੁਦ ਦੀ ਫਰੰਟਐਂਡ ਐਪਲੀਕੇਸ਼ਨ ਬਣਾਉਣ, ਆਪਣੇ ਖੁਦ ਦੇ HTML ਪੰਨੇ ਬਣਾਉਣ, ਅਤੇ ਵੱਖ-ਵੱਖ ਡੇਟਾ ਦੀ ਕਲਪਨਾ ਕਰਨ ਲਈ ਡੇਟਾਸੋਰਸ ਨੂੰ ਹੱਥੀਂ ਐਕਸੈਸ ਕਰਨ ਦੀ ਆਗਿਆ ਦਿੰਦਾ ਹੈ। ਹੋਰ ਪਲੱਗਇਨ ਕਿਸਮਾਂ (ਡੇਟਾਸੋਰਸ, ਪੈਨਲ) ਅਤੇ ਵੱਖ-ਵੱਖ ਡੈਸ਼ਬੋਰਡਾਂ ਨੂੰ ਵੀ ਨਿਰਭਰਤਾ ਵਜੋਂ ਵਰਤਿਆ ਜਾ ਸਕਦਾ ਹੈ।

ਕਿਸਮ = ਐਪ ਨਾਲ ਪਲੱਗਇਨ ਨਿਰਭਰਤਾਵਾਂ ਦੀ ਉਦਾਹਰਣ.

ਤੁਸੀਂ ਪ੍ਰੋਗਰਾਮਿੰਗ ਭਾਸ਼ਾ ਵਜੋਂ JavaScript ਜਾਂ TypeScript ਦੀ ਵਰਤੋਂ ਕਰ ਸਕਦੇ ਹੋ (ਅਸੀਂ TypeScript ਚੁਣਿਆ ਹੈ)। ਤੁਸੀਂ ਕਿਸੇ ਵੀ ਕਿਸਮ ਦੇ hello-world ਪਲੱਗਇਨ ਲਈ ਟੈਂਪਲੇਟ ਬਣਾ ਸਕਦੇ ਹੋ। ਲਿੰਕ ਦੁਆਰਾ ਲੱਭੋ: ਇਸ ਰਿਪੋਜ਼ਟਰੀ ਵਿੱਚ ਪਹਿਲਾਂ ਤੋਂ ਸਥਾਪਿਤ ਅਤੇ ਸੰਰਚਿਤ ਬਿਲਡਰਾਂ ਦੇ ਨਾਲ ਵੱਡੀ ਗਿਣਤੀ ਵਿੱਚ ਸਟਾਰਟਰ ਪੈਕ (ਇੱਕ ਰੀਐਕਟ ਪਲੱਗਇਨ ਦੀ ਇੱਕ ਪ੍ਰਯੋਗਾਤਮਕ ਉਦਾਹਰਣ ਵੀ ਹੈ) ਹਨ।

ਭਾਗ 2: ਸਥਾਨਕ ਵਾਤਾਵਰਣ ਨੂੰ ਤਿਆਰ ਕਰਨਾ

ਪਲੱਗਇਨ 'ਤੇ ਕੰਮ ਕਰਨ ਲਈ, ਸਾਨੂੰ ਕੁਦਰਤੀ ਤੌਰ 'ਤੇ ਸਾਰੇ ਪਹਿਲਾਂ ਤੋਂ ਸਥਾਪਿਤ ਟੂਲਸ ਦੇ ਨਾਲ ਇੱਕ ਕੁਬਰਨੇਟਸ ਕਲੱਸਟਰ ਦੀ ਜ਼ਰੂਰਤ ਹੋਏਗੀ: ਪ੍ਰੋਮੀਥੀਅਸ, ਨੋਡ-ਐਕਸਪੋਰਟਰ, ਕਿਊਬ-ਸਟੇਟ-ਮੈਟ੍ਰਿਕਸ, ਅਤੇ ਗ੍ਰਾਫਾਨਾ। ਵਾਤਾਵਰਣ ਤੇਜ਼, ਆਸਾਨ ਅਤੇ ਸੈੱਟਅੱਪ ਕਰਨ ਲਈ ਮੁਸ਼ਕਲ ਰਹਿਤ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ, ਅਤੇ ਗਰਮ ਰੀਲੋਡਿੰਗ ਨੂੰ ਯਕੀਨੀ ਬਣਾਉਣ ਲਈ, ਗ੍ਰਾਫਾਨਾ ਡੇਟਾ ਡਾਇਰੈਕਟਰੀ ਨੂੰ ਡਿਵੈਲਪਰ ਦੀ ਮਸ਼ੀਨ ਤੋਂ ਸਿੱਧਾ ਮਾਊਂਟ ਕੀਤਾ ਜਾਣਾ ਚਾਹੀਦਾ ਹੈ।

ਸਾਡੀ ਰਾਏ ਵਿੱਚ, ਕੁਬਰਨੇਟਸ ਨਾਲ ਸਥਾਨਕ ਤੌਰ 'ਤੇ ਕੰਮ ਕਰਨ ਦਾ ਸਭ ਤੋਂ ਸੁਵਿਧਾਜਨਕ ਤਰੀਕਾ ਹੈ minikubeਅਗਲਾ ਕਦਮ ਪ੍ਰੋਮੀਥੀਅਸ-ਓਪਰੇਟਰ ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਪ੍ਰੋਮੀਥੀਅਸ + ਗ੍ਰਾਫਾਨਾ ਬੰਡਲ ਨੂੰ ਸਥਾਪਿਤ ਕਰਨਾ ਹੈ। ਇਹ ਲੇਖ ਮਿਨੀਕਿਊਬ 'ਤੇ ਪ੍ਰੋਮੀਥੀਅਸ-ਓਪਰੇਟਰ ਸਥਾਪਤ ਕਰਨ ਦੀ ਪ੍ਰਕਿਰਿਆ ਦਾ ਵਿਸਥਾਰ ਵਿੱਚ ਵਰਣਨ ਕੀਤਾ ਗਿਆ ਹੈ। ਸਥਿਰਤਾ ਨੂੰ ਸਮਰੱਥ ਬਣਾਉਣ ਲਈ, ਤੁਹਾਨੂੰ ਪੈਰਾਮੀਟਰ ਸੈੱਟ ਕਰਨ ਦੀ ਲੋੜ ਹੈ ਦ੍ਰਿੜਤਾ: ਸੱਚ charts/grafana/values.yaml ਫਾਈਲ ਵਿੱਚ, ਆਪਣਾ PV ਅਤੇ PVC ਜੋੜੋ ਅਤੇ ਉਹਨਾਂ ਨੂੰ persistence.existingClaim ਪੈਰਾਮੀਟਰ ਵਿੱਚ ਦੱਸੋ।

ਸਾਡੀ ਅੰਤਿਮ ਮਿਨੀਕਿਊਬ ਲਾਂਚ ਸਕ੍ਰਿਪਟ ਇਸ ਤਰ੍ਹਾਂ ਦਿਖਾਈ ਦਿੰਦੀ ਹੈ:

minikube start --kubernetes-version=v1.13.4 --memory=4096 --bootstrapper=kubeadm --extra-config=scheduler.address=0.0.0.0 --extra-config=controller-manager.address=0.0.0.0
minikube mount 
/home/sergeisporyshev/Projects/Grafana:/var/grafana --gid=472 --uid=472 --9p-version=9p2000.L

ਭਾਗ 3: ਸਿੱਧਾ ਵਿਕਾਸ

ਵਸਤੂ ਮਾਡਲ

ਪਲੱਗਇਨ ਦੇ ਲਾਗੂ ਕਰਨ ਦੀ ਤਿਆਰੀ ਵਿੱਚ, ਅਸੀਂ ਉਹਨਾਂ ਸਾਰੀਆਂ ਬੁਨਿਆਦੀ Kubernetes ਇਕਾਈਆਂ ਨੂੰ ਪਰਿਭਾਸ਼ਿਤ ਕਰਨ ਦਾ ਫੈਸਲਾ ਕੀਤਾ ਹੈ ਜਿਨ੍ਹਾਂ ਨਾਲ ਅਸੀਂ TypeScript ਕਲਾਸਾਂ ਦੇ ਰੂਪ ਵਿੱਚ ਕੰਮ ਕਰਾਂਗੇ: pod, deployment, daemonset, statefulset, job, cronjob, service, node, ਅਤੇ namespace। ਇਹਨਾਂ ਵਿੱਚੋਂ ਹਰੇਕ ਕਲਾਸ ਇੱਕ ਆਮ BaseModel ਕਲਾਸ ਤੋਂ ਪ੍ਰਾਪਤ ਹੁੰਦੀ ਹੈ, ਜੋ ਇੱਕ ਕੰਸਟਰਕਟਰ, ਡਿਸਟ੍ਰਕਟਰ, ਅਤੇ ਦਿੱਖ ਨੂੰ ਅੱਪਡੇਟ ਕਰਨ ਅਤੇ ਟੌਗਲ ਕਰਨ ਦੇ ਤਰੀਕਿਆਂ ਨੂੰ ਪਰਿਭਾਸ਼ਿਤ ਕਰਦੀ ਹੈ। ਹਰੇਕ ਕਲਾਸ ਹੋਰ ਇਕਾਈਆਂ ਨਾਲ ਨੇਸਟਡ ਸਬੰਧਾਂ ਨੂੰ ਵੀ ਪਰਿਭਾਸ਼ਿਤ ਕਰਦੀ ਹੈ, ਜਿਵੇਂ ਕਿ ਇੱਕ ਡਿਪਲਾਇਮੈਂਟ ਇਕਾਈ ਲਈ ਪੌਡ ਦੀ ਸੂਚੀ।

import {Pod} from "./pod";
import {Service} from "./service";
import {BaseModel} from './traits/baseModel';

export class Deployment extends BaseModel{
   pods: Array<Pod>;
   services: Array<Service>;

   constructor(data: any){
       super(data);
       this.pods = [];
       this.services = [];
   }
}

ਗੇਟਰ ਅਤੇ ਸੈਟਰ ਦੀ ਵਰਤੋਂ ਕਰਕੇ, ਅਸੀਂ ਲੋੜੀਂਦੇ ਐਂਟੀਟੀ ਮੈਟ੍ਰਿਕਸ ਨੂੰ ਇੱਕ ਸੁਵਿਧਾਜਨਕ ਅਤੇ ਪੜ੍ਹਨਯੋਗ ਫਾਰਮੈਟ ਵਿੱਚ ਪ੍ਰਦਰਸ਼ਿਤ ਜਾਂ ਸੈੱਟ ਕਰ ਸਕਦੇ ਹਾਂ। ਉਦਾਹਰਣ ਵਜੋਂ, ਨਿਰਧਾਰਤ CPU ਨੋਡਾਂ ਦਾ ਫਾਰਮੈਟ ਕੀਤਾ ਆਉਟਪੁੱਟ:

get cpuAllocatableFormatted(){
   let cpu = this.data.status.allocatable.cpu;
   if(cpu.indexOf('m') > -1){
       cpu = parseInt(cpu)/1000;
   }
   return cpu;
}

ਪੰਨੇ

ਸਾਡੇ ਪਲੱਗਇਨ ਦੇ ਸਾਰੇ ਪੰਨਿਆਂ ਦੀ ਸੂਚੀ ਸ਼ੁਰੂ ਵਿੱਚ ਸਾਡੇ pluing.json ਵਿੱਚ ਨਿਰਭਰਤਾ ਭਾਗ ਵਿੱਚ ਦੱਸੀ ਗਈ ਹੈ:

ਹਰੇਕ ਪੰਨੇ ਦੇ ਬਲਾਕ ਵਿੱਚ, ਸਾਨੂੰ PAGE NAME (ਇਸਨੂੰ ਫਿਰ ਇੱਕ ਸਲੱਗ ਵਿੱਚ ਬਦਲਿਆ ਜਾਵੇਗਾ ਜਿਸ ਦੁਆਰਾ ਇਹ ਪੰਨਾ ਪਹੁੰਚਯੋਗ ਹੋਵੇਗਾ); ਇਸ ਪੰਨੇ ਦੇ ਸੰਚਾਲਨ ਲਈ ਜ਼ਿੰਮੇਵਾਰ ਹਿੱਸੇ ਦਾ ਨਾਮ (ਭਾਗਾਂ ਦੀ ਸੂਚੀ module.ts ਨੂੰ ਨਿਰਯਾਤ ਕੀਤੀ ਜਾਂਦੀ ਹੈ); ਉਪਭੋਗਤਾ ਦੀ ਭੂਮਿਕਾ ਦਾ ਸੰਕੇਤ ਜਿਸ ਲਈ ਇਸ ਪੰਨੇ ਨਾਲ ਕੰਮ ਉਪਲਬਧ ਹੈ ਅਤੇ ਸਾਈਡਬਾਰ ਲਈ ਨੈਵੀਗੇਸ਼ਨ ਸੈਟਿੰਗਾਂ।

ਪੰਨੇ ਦੇ ਸੰਚਾਲਨ ਲਈ ਜ਼ਿੰਮੇਵਾਰ ਹਿੱਸੇ ਵਿੱਚ, ਸਾਨੂੰ ਟੈਂਪਲੇਟ ਯੂਆਰਐਲ ਸੈੱਟ ਕਰਨਾ ਚਾਹੀਦਾ ਹੈ, ਇਸਨੂੰ ਮਾਰਕਅੱਪ ਵਾਲੀ HTML ਫਾਈਲ ਦਾ ਮਾਰਗ ਦੇਣਾ ਚਾਹੀਦਾ ਹੈ। ਕੰਟਰੋਲਰ ਦੇ ਅੰਦਰ, ਨਿਰਭਰਤਾ ਇੰਜੈਕਸ਼ਨ ਰਾਹੀਂ, ਅਸੀਂ ਦੋ ਮਹੱਤਵਪੂਰਨ ਐਂਗੂਲਰ ਸੇਵਾਵਾਂ ਤੱਕ ਪਹੁੰਚ ਕਰ ਸਕਦੇ ਹਾਂ:

• backendSrv ਇੱਕ ਸੇਵਾ ਹੈ ਜੋ Grafana API ਸਰਵਰ ਨਾਲ ਇੰਟਰੈਕਸ਼ਨ ਪ੍ਰਦਾਨ ਕਰਦੀ ਹੈ;
• datasourceSrv ਇੱਕ ਸੇਵਾ ਹੈ ਜੋ ਤੁਹਾਡੇ Grafana ਵਿੱਚ ਸਥਾਪਿਤ ਸਾਰੇ ਡੇਟਾ ਸਰੋਤਾਂ ਨਾਲ ਸਥਾਨਕ ਪਰਸਪਰ ਪ੍ਰਭਾਵ ਪ੍ਰਦਾਨ ਕਰਦੀ ਹੈ (ਉਦਾਹਰਣ ਵਜੋਂ, .getAll() ਵਿਧੀ ਸਾਰੇ ਸਥਾਪਤ ਡੇਟਾ ਸਰੋਤਾਂ ਦੀ ਸੂਚੀ ਵਾਪਸ ਕਰਦੀ ਹੈ; .get( ) — ਇੱਕ ਖਾਸ ਡੇਟਾ ਸਰੋਤ ਦਾ ਇੱਕ ਉਦਾਹਰਣ ਵਸਤੂ ਵਾਪਸ ਕਰਦਾ ਹੈ।

ਭਾਗ 4: ਡੇਟਾ ਸਰੋਤ

ਗ੍ਰਾਫਾਨਾ ਦੇ ਦ੍ਰਿਸ਼ਟੀਕੋਣ ਤੋਂ, ਇੱਕ ਡੇਟਾਸੋਰਸ ਕਿਸੇ ਵੀ ਹੋਰ ਪਲੱਗਇਨ ਵਾਂਗ ਇੱਕ ਪਲੱਗਇਨ ਹੈ: ਇਸਦਾ ਆਪਣਾ ਐਂਟਰੀ ਪੁਆਇੰਟ, module.js, ਅਤੇ ਮੈਟਾਡੇਟਾ ਵਾਲੀ ਇੱਕ plugin.json ਫਾਈਲ ਹੈ। type = app ਨਾਲ ਇੱਕ ਪਲੱਗਇਨ ਵਿਕਸਤ ਕਰਦੇ ਸਮੇਂ, ਅਸੀਂ ਮੌਜੂਦਾ ਡੇਟਾਸੋਰਸ (ਉਦਾਹਰਨ ਲਈ, prometheus-datasource) ਜਾਂ ਆਪਣੇ ਨਾਲ ਇੰਟਰੈਕਟ ਕਰ ਸਕਦੇ ਹਾਂ, ਜਿਸਨੂੰ ਅਸੀਂ ਸਿੱਧੇ ਪਲੱਗਇਨ ਡਾਇਰੈਕਟਰੀ (dist/datasource/*) ਵਿੱਚ ਸਟੋਰ ਕਰ ਸਕਦੇ ਹਾਂ ਜਾਂ ਇੱਕ ਨਿਰਭਰਤਾ ਵਜੋਂ ਸਥਾਪਿਤ ਕਰ ਸਕਦੇ ਹਾਂ। ਸਾਡੇ ਕੇਸ ਵਿੱਚ, ਡੇਟਾਸੋਰਸ ਪਲੱਗਇਨ ਕੋਡ ਨਾਲ ਬੰਡਲ ਕੀਤਾ ਗਿਆ ਹੈ। ਇੱਕ config.html ਟੈਂਪਲੇਟ ਅਤੇ ਇੱਕ ConfigCtrl ਕੰਟਰੋਲਰ ਦੀ ਵੀ ਲੋੜ ਹੈ, ਜੋ ਕਿ ਡੇਟਾਸੋਰਸ ਇੰਸਟੈਂਸ ਕੌਂਫਿਗਰੇਸ਼ਨ ਪੰਨੇ ਅਤੇ ਡੇਟਾਸੋਰਸ ਕੰਟਰੋਲਰ ਲਈ ਵਰਤਿਆ ਜਾਵੇਗਾ, ਜੋ ਤੁਹਾਡੇ ਡੇਟਾਸੋਰਸ ਲਈ ਤਰਕ ਨੂੰ ਲਾਗੂ ਕਰਦਾ ਹੈ।

KubeGraf ਪਲੱਗਇਨ ਵਿੱਚ, ਇੱਕ ਯੂਜ਼ਰ ਇੰਟਰਫੇਸ ਦੇ ਦ੍ਰਿਸ਼ਟੀਕੋਣ ਤੋਂ, ਇੱਕ ਡੇਟਾਸੋਰਸ ਇੱਕ Kubernetes ਕਲੱਸਟਰ ਦਾ ਇੱਕ ਉਦਾਹਰਣ ਹੈ ਜੋ ਹੇਠ ਲਿਖੀਆਂ ਸਮਰੱਥਾਵਾਂ ਨੂੰ ਲਾਗੂ ਕਰਦਾ ਹੈ (ਸਰੋਤ ਕੋਡ ਉਪਲਬਧ ਹੈ)। ਲਿੰਕ):

• k8s api ਸਰਵਰ ਤੋਂ ਡਾਟਾ ਪ੍ਰਾਪਤ ਕਰਨਾ (ਨੇਮਸਪੇਸਾਂ, ਤੈਨਾਤੀਆਂ, ਆਦਿ ਦੀ ਸੂਚੀ ਪ੍ਰਾਪਤ ਕਰਨਾ)
• ਪ੍ਰੋਮੀਥੀਅਸ-ਡੇਟਾਸੋਰਸ (ਜੋ ਕਿ ਹਰੇਕ ਖਾਸ ਕਲੱਸਟਰ ਲਈ ਪਲੱਗਇਨ ਸੈਟਿੰਗਾਂ ਵਿੱਚ ਚੁਣਿਆ ਜਾਂਦਾ ਹੈ) ਨੂੰ ਬੇਨਤੀਆਂ ਦੀ ਪ੍ਰੌਕਸੀ ਕਰਨਾ ਅਤੇ ਸਥਿਰ ਪੰਨਿਆਂ ਅਤੇ ਡੈਸ਼ਬੋਰਡਾਂ ਦੋਵਾਂ ਵਿੱਚ ਡੇਟਾ ਦੀ ਵਰਤੋਂ ਲਈ ਜਵਾਬਾਂ ਨੂੰ ਫਾਰਮੈਟ ਕਰਨਾ।
• ਪਲੱਗਇਨ ਦੇ ਸਥਿਰ ਪੰਨਿਆਂ 'ਤੇ ਡੇਟਾ ਨੂੰ ਅਪਡੇਟ ਕਰਨਾ (ਇੱਕ ਸੈੱਟ ਰਿਫਰੈਸ਼ ਰੇਟ ਦੇ ਨਾਲ)।
• ਗ੍ਰਾਫਾਨਾ-ਡੈਸ਼ਬੋਰਡਾਂ ਵਿੱਚ ਇੱਕ ਟੈਂਪਲੇਟ ਸ਼ੀਟ ਤਿਆਰ ਕਰਨ ਲਈ ਪੁੱਛਗਿੱਛਾਂ ਦੀ ਪ੍ਰਕਿਰਿਆ ਕਰਨਾ (ਵਿਧੀ .metriFindQuery())

• ਅੰਤਿਮ k8s ਕਲੱਸਟਰ ਨਾਲ ਕਨੈਕਸ਼ਨ ਟੈਸਟ।

testDatasource(){
   let url = '/api/v1/namespaces';
   let _url = this.url;
   if(this.accessViaToken)
       _url += '/__proxy';
   _url += url;
   return this.backendSrv.datasourceRequest({
       url: _url,
       method: "GET",
       headers: {"Content-Type": 'application/json'}
   })
       .then(response => {
           if (response.status === 200) {
               return {status: "success", message: "Data source is OK", title: "Success"};
           }else{
               return {status: "error", message: "Data source is not OK", title: "Error"};
           }
       }, error => {
           return {status: "error", message: "Data source is not OK", title: "Error"};
       })
}

ਇੱਕ ਖਾਸ ਦਿਲਚਸਪ ਪਹਿਲੂ, ਸਾਡੀ ਰਾਏ ਵਿੱਚ, ਡੇਟਾ ਸਰੋਤ ਲਈ ਪ੍ਰਮਾਣੀਕਰਨ ਅਤੇ ਅਧਿਕਾਰ ਵਿਧੀ ਨੂੰ ਲਾਗੂ ਕਰਨਾ ਹੈ। ਆਮ ਤੌਰ 'ਤੇ, ਬਾਕਸ ਤੋਂ ਬਾਹਰ, ਅਸੀਂ ਅੰਤਮ ਡੇਟਾ ਸਰੋਤ ਤੱਕ ਪਹੁੰਚ ਨੂੰ ਕੌਂਫਿਗਰ ਕਰਨ ਲਈ ਗ੍ਰਾਫਾਨਾ ਦੇ ਬਿਲਟ-ਇਨ ਡੇਟਾ ਸਰੋਤHttpSettings ਕੰਪੋਨੈਂਟ ਦੀ ਵਰਤੋਂ ਕਰ ਸਕਦੇ ਹਾਂ। ਇਸ ਕੰਪੋਨੈਂਟ ਦੇ ਨਾਲ, ਅਸੀਂ URL ਅਤੇ ਬੁਨਿਆਦੀ ਪ੍ਰਮਾਣੀਕਰਨ/ਅਧਿਕਾਰ ਸੈਟਿੰਗਾਂ ਨੂੰ ਨਿਰਧਾਰਤ ਕਰਕੇ HTTP ਡੇਟਾ ਸਰੋਤ ਤੱਕ ਪਹੁੰਚ ਨੂੰ ਕੌਂਫਿਗਰ ਕਰ ਸਕਦੇ ਹਾਂ: ਲੌਗਇਨ/ਪਾਸਵਰਡ, ਜਾਂ ਕਲਾਇੰਟ-ਸਰਟੀਫਿਕੇਟ/ਕਲਾਇੰਟ-ਕੁੰਜੀ। ਇੱਕ ਬੇਅਰਰ ਟੋਕਨ (k8s ਲਈ ਅਸਲ ਮਿਆਰ) ਦੀ ਵਰਤੋਂ ਕਰਕੇ ਪਹੁੰਚ ਨੂੰ ਕੌਂਫਿਗਰ ਕਰਨ ਦੀ ਯੋਗਤਾ ਨੂੰ ਲਾਗੂ ਕਰਨ ਲਈ ਕੁਝ ਟਿੰਕਰਿੰਗ ਦੀ ਲੋੜ ਸੀ।

ਇਸ ਸਮੱਸਿਆ ਨੂੰ ਹੱਲ ਕਰਨ ਲਈ, ਤੁਸੀਂ ਗ੍ਰਾਫਾਨਾ ਦੇ ਬਿਲਟ-ਇਨ "ਪਲੱਗਇਨ ਰੂਟਸ" ਵਿਧੀ ਦੀ ਵਰਤੋਂ ਕਰ ਸਕਦੇ ਹੋ (ਇਸ ਬਾਰੇ ਹੋਰ ਵੇਰਵੇ ਅਧਿਕਾਰਤ ਦਸਤਾਵੇਜ਼ ਪੰਨਾ). ਸਾਡੀਆਂ ਡੇਟਾਸੋਰਸ ਸੈਟਿੰਗਾਂ ਵਿੱਚ, ਅਸੀਂ ਰੂਟਿੰਗ ਨਿਯਮਾਂ ਦਾ ਇੱਕ ਸੈੱਟ ਘੋਸ਼ਿਤ ਕਰ ਸਕਦੇ ਹਾਂ ਜੋ ਗ੍ਰਾਫਾਨਾ ਪ੍ਰੌਕਸੀ ਸਰਵਰ ਦੁਆਰਾ ਪ੍ਰਕਿਰਿਆ ਕੀਤੇ ਜਾਣਗੇ। ਉਦਾਹਰਣ ਵਜੋਂ, ਹਰੇਕ ਵਿਅਕਤੀਗਤ ਅੰਤਮ ਬਿੰਦੂ ਲਈ, ਟੈਂਪਲੇਟ ਸਹਾਇਤਾ ਨਾਲ ਹੈਡਰ ਜਾਂ URL ਸੈੱਟ ਕਰਨ ਦਾ ਵਿਕਲਪ ਹੈ, ਜਿਸ ਲਈ ਡੇਟਾ jsonData ਅਤੇ secureJsonData ਖੇਤਰਾਂ ਤੋਂ ਲਿਆ ਜਾ ਸਕਦਾ ਹੈ (ਪਾਸਵਰਡ ਜਾਂ ਟੋਕਨਾਂ ਨੂੰ ਏਨਕ੍ਰਿਪਟਡ ਰੂਪ ਵਿੱਚ ਸਟੋਰ ਕਰਨ ਲਈ)। ਸਾਡੀ ਉਦਾਹਰਣ ਵਿੱਚ, ਫਾਰਮ ਦੀਆਂ ਬੇਨਤੀਆਂ /__ਪ੍ਰੌਕਸੀ/ਏਪੀਆਈ/ਵੀ1/ਨੇਮਸਪੇਸ ਹੇਠ ਦਿੱਤੀ ਕਿਸਮ ਦੇ URL ਨਾਲ ਪ੍ਰੌਕਸੀ ਕੀਤਾ ਜਾਵੇਗਾ
/api/v1/namespaces ਅਧਿਕਾਰ ਦੇ ਨਾਲ: ਬੇਅਰਰ ਹੈਡਰ ਸੈੱਟ।

ਕੁਦਰਤੀ ਤੌਰ 'ਤੇ, k8s api ਸਰਵਰ ਨਾਲ ਕੰਮ ਕਰਨ ਲਈ, ਸਾਨੂੰ ਸਿਰਫ਼-ਪੜ੍ਹਨ ਵਾਲੀ ਪਹੁੰਚ ਵਾਲੇ ਉਪਭੋਗਤਾ ਦੀ ਲੋੜ ਹੁੰਦੀ ਹੈ, ਬਣਾਉਣ ਲਈ ਮੈਨੀਫੈਸਟ ਜੋ ਤੁਸੀਂ ਇਸ ਵਿੱਚ ਵੀ ਲੱਭ ਸਕਦੇ ਹੋ ਪਲੱਗਇਨ ਸਰੋਤ ਕੋਡ.

ਭਾਗ 5: ਰਿਹਾਈ

ਇੱਕ ਵਾਰ ਜਦੋਂ ਤੁਸੀਂ ਆਪਣਾ ਗ੍ਰਾਫਾਨਾ ਪਲੱਗਇਨ ਲਿਖ ਲੈਂਦੇ ਹੋ, ਤਾਂ ਤੁਸੀਂ ਕੁਦਰਤੀ ਤੌਰ 'ਤੇ ਇਸਨੂੰ ਓਪਨ ਸੋਰਸ ਬਣਾਉਣਾ ਚਾਹੋਗੇ। ਗ੍ਰਾਫਾਨਾ ਵਿੱਚ, ਇਹ ਇੱਕ ਪਲੱਗਇਨ ਲਾਇਬ੍ਰੇਰੀ ਹੈ, ਜੋ ਕਿ ਇੱਥੇ ਉਪਲਬਧ ਹੈ grafana.com/grafana/plugins

ਤੁਹਾਡੇ ਪਲੱਗਇਨ ਨੂੰ ਅਧਿਕਾਰਤ ਸਟੋਰ ਵਿੱਚ ਉਪਲਬਧ ਕਰਵਾਉਣ ਲਈ, ਤੁਹਾਨੂੰ ਇੱਕ PR ਬਣਾਉਣ ਦੀ ਲੋੜ ਹੈ ਇਹ ਰਿਪੋਜ਼ਟਰੀ, repo.json ਫਾਈਲ ਵਿੱਚ ਇਸ ਤਰ੍ਹਾਂ ਦੀ ਸਮੱਗਰੀ ਜੋੜਨਾ:

ਜਿੱਥੇ version ਤੁਹਾਡੇ ਪਲੱਗਇਨ ਦਾ ਵਰਜਨ ਹੈ, url ਰਿਪੋਜ਼ਟਰੀ ਦਾ ਲਿੰਕ ਹੈ, ਅਤੇ commit ਕਮਿਟ ਦਾ ਹੈਸ਼ ਹੈ ਜੋ ਪਲੱਗਇਨ ਦੇ ਖਾਸ ਵਰਜਨ ਨੂੰ ਉਪਲਬਧ ਕਰਵਾਏਗਾ।

ਅਤੇ ਆਉਟਪੁੱਟ 'ਤੇ ਤੁਸੀਂ ਇਸ ਤਰ੍ਹਾਂ ਦੀ ਇੱਕ ਸ਼ਾਨਦਾਰ ਤਸਵੀਰ ਵੇਖੋਗੇ:

ਇਸਦੇ ਲਈ ਡੇਟਾ ਤੁਹਾਡੇ Readme.md, Changelog.md, ਅਤੇ plugin.json ਫਾਈਲ ਤੋਂ ਪਲੱਗਇਨ ਵੇਰਵੇ ਦੇ ਨਾਲ ਆਪਣੇ ਆਪ ਪ੍ਰਾਪਤ ਕਰ ਲਿਆ ਜਾਵੇਗਾ।

ਭਾਗ 6: ਸਿੱਟਿਆਂ ਦੀ ਬਜਾਏ

ਅਸੀਂ ਆਪਣੇ ਪਲੱਗਇਨ ਨੂੰ ਇਸਦੇ ਰਿਲੀਜ਼ ਹੋਣ ਤੋਂ ਬਾਅਦ ਵਿਕਸਤ ਕਰਨਾ ਬੰਦ ਨਹੀਂ ਕੀਤਾ ਹੈ। ਅਸੀਂ ਵਰਤਮਾਨ ਵਿੱਚ ਕਲੱਸਟਰ ਨੋਡ ਸਰੋਤ ਵਰਤੋਂ ਦੀ ਸਹੀ ਢੰਗ ਨਾਲ ਨਿਗਰਾਨੀ ਕਰਨ, ਉਪਭੋਗਤਾ ਅਨੁਭਵ ਨੂੰ ਬਿਹਤਰ ਬਣਾਉਣ ਲਈ ਨਵੀਆਂ ਵਿਸ਼ੇਸ਼ਤਾਵਾਂ ਨੂੰ ਲਾਗੂ ਕਰਨ, ਅਤੇ ਪਲੱਗਇਨ ਸਥਾਪਤ ਕਰਨ ਤੋਂ ਬਾਅਦ ਸਾਡੇ ਗਾਹਕਾਂ ਅਤੇ GitHub 'ਤੇ ਉਪਭੋਗਤਾਵਾਂ ਦੋਵਾਂ ਤੋਂ ਪ੍ਰਾਪਤ ਹੋਈ ਵੱਡੀ ਮਾਤਰਾ ਵਿੱਚ ਫੀਡਬੈਕ ਨੂੰ ਛਾਂਟਣ 'ਤੇ ਕੰਮ ਕਰ ਰਹੇ ਹਾਂ (ਜੇਕਰ ਤੁਸੀਂ ਕੋਈ ਮੁੱਦਾ ਜਾਂ ਪੁੱਲ ਬੇਨਤੀ ਛੱਡਦੇ ਹੋ, ਤਾਂ ਮੈਨੂੰ ਬਹੁਤ ਖੁਸ਼ੀ ਹੋਵੇਗੀ :))।

ਸਾਨੂੰ ਉਮੀਦ ਹੈ ਕਿ ਇਹ ਲੇਖ ਤੁਹਾਨੂੰ ਗ੍ਰਾਫਾਨਾ ਵਰਗੇ ਸ਼ਾਨਦਾਰ ਟੂਲ ਨੂੰ ਸਮਝਣ ਵਿੱਚ ਮਦਦ ਕਰੇਗਾ ਅਤੇ, ਸ਼ਾਇਦ, ਆਪਣਾ ਪਲੱਗਇਨ ਲਿਖਣ ਵਿੱਚ ਵੀ ਮਦਦ ਕਰੇਗਾ।

ਤੁਹਾਡਾ ਧੰਨਵਾਦ!)

ਸਰੋਤ: www.habr.com